@smithy/core 3.33.3 → 3.34.0

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/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Change Log
2
2
 
3
+ ## 3.34.0
4
+
5
+ ### Minor Changes
6
+
7
+ - c45b1ba: Add custom error classes to identify and differentiate Smithy runtime errors from other errors.
8
+
9
+ ### Patch Changes
10
+
11
+ - fbcc573: identify AbortError as terminal
12
+
3
13
  ## 3.33.3
4
14
 
5
15
  ### Patch Changes
@@ -0,0 +1,20 @@
1
+ class SmithyError extends Error {
2
+ name = "SmithyError";
3
+ $source = errors.$source;
4
+ }
5
+ class SmithyTypeError extends TypeError {
6
+ name = "SmithyTypeError";
7
+ $source = errors.$source;
8
+ }
9
+ class SmithyRangeError extends RangeError {
10
+ name = "SmithyRangeError";
11
+ $source = errors.$source;
12
+ }
13
+ const errors = {
14
+ $source: "smithy",
15
+ Error: SmithyError,
16
+ TypeError: SmithyTypeError,
17
+ RangeError: SmithyRangeError,
18
+ };
19
+
20
+ exports.errors = errors;
@@ -55,16 +55,17 @@ const isBrowserNetworkError = (error) => {
55
55
  const isThrottlingError = (error) => error.$metadata?.httpStatusCode === 429 ||
56
56
  THROTTLING_ERROR_CODES.includes(error.name) ||
57
57
  error.$retryable?.throttling == true;
58
- const isTransientError = (error, depth = 0) => isRetryableByTrait(error) ||
59
- isClockSkewCorrectedError(error) ||
60
- (error.name === "InvalidSignatureException" && error.message?.includes("Signature expired")) ||
61
- TRANSIENT_ERROR_CODES.includes(error.name) ||
62
- NODEJS_TIMEOUT_ERROR_CODES.includes(error?.code || "") ||
63
- NODEJS_NETWORK_ERROR_CODES.includes(error?.code || "") ||
64
- TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
65
- isBrowserNetworkError(error) ||
66
- isNodeJsHttp2TransientError(error) ||
67
- (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1));
58
+ const isTransientError = (error, depth = 0) => error?.name !== "AbortError" &&
59
+ (isRetryableByTrait(error) ||
60
+ isClockSkewCorrectedError(error) ||
61
+ (error.name === "InvalidSignatureException" && error.message?.includes("Signature expired")) ||
62
+ TRANSIENT_ERROR_CODES.includes(error.name) ||
63
+ NODEJS_TIMEOUT_ERROR_CODES.includes(error?.code || "") ||
64
+ NODEJS_NETWORK_ERROR_CODES.includes(error?.code || "") ||
65
+ TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
66
+ isBrowserNetworkError(error) ||
67
+ isNodeJsHttp2TransientError(error) ||
68
+ (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1)));
68
69
  const isServerError = (error) => {
69
70
  if (error.$metadata?.httpStatusCode !== undefined) {
70
71
  const statusCode = error.$metadata.httpStatusCode;
@@ -57,16 +57,17 @@ const isBrowserNetworkError = (error) => {
57
57
  const isThrottlingError = (error) => error.$metadata?.httpStatusCode === 429 ||
58
58
  THROTTLING_ERROR_CODES.includes(error.name) ||
59
59
  error.$retryable?.throttling == true;
60
- const isTransientError = (error, depth = 0) => isRetryableByTrait(error) ||
61
- isClockSkewCorrectedError(error) ||
62
- (error.name === "InvalidSignatureException" && error.message?.includes("Signature expired")) ||
63
- TRANSIENT_ERROR_CODES.includes(error.name) ||
64
- NODEJS_TIMEOUT_ERROR_CODES.includes(error?.code || "") ||
65
- NODEJS_NETWORK_ERROR_CODES.includes(error?.code || "") ||
66
- TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
67
- isBrowserNetworkError(error) ||
68
- isNodeJsHttp2TransientError(error) ||
69
- (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1));
60
+ const isTransientError = (error, depth = 0) => error?.name !== "AbortError" &&
61
+ (isRetryableByTrait(error) ||
62
+ isClockSkewCorrectedError(error) ||
63
+ (error.name === "InvalidSignatureException" && error.message?.includes("Signature expired")) ||
64
+ TRANSIENT_ERROR_CODES.includes(error.name) ||
65
+ NODEJS_TIMEOUT_ERROR_CODES.includes(error?.code || "") ||
66
+ NODEJS_NETWORK_ERROR_CODES.includes(error?.code || "") ||
67
+ TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
68
+ isBrowserNetworkError(error) ||
69
+ isNodeJsHttp2TransientError(error) ||
70
+ (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1)));
70
71
  const isServerError = (error) => {
71
72
  if (error.$metadata?.httpStatusCode !== undefined) {
72
73
  const statusCode = error.$metadata.httpStatusCode;
@@ -0,0 +1,18 @@
1
+ export class SmithyError extends Error {
2
+ name = "SmithyError";
3
+ $source = errors.$source;
4
+ }
5
+ export class SmithyTypeError extends TypeError {
6
+ name = "SmithyTypeError";
7
+ $source = errors.$source;
8
+ }
9
+ export class SmithyRangeError extends RangeError {
10
+ name = "SmithyRangeError";
11
+ $source = errors.$source;
12
+ }
13
+ export const errors = {
14
+ $source: "smithy",
15
+ Error: SmithyError,
16
+ TypeError: SmithyTypeError,
17
+ RangeError: SmithyRangeError,
18
+ };
@@ -0,0 +1 @@
1
+ export { errors } from "./errors";
@@ -19,16 +19,17 @@ export const isBrowserNetworkError = (error) => {
19
19
  export const isThrottlingError = (error) => error.$metadata?.httpStatusCode === 429 ||
20
20
  THROTTLING_ERROR_CODES.includes(error.name) ||
21
21
  error.$retryable?.throttling == true;
22
- export const isTransientError = (error, depth = 0) => isRetryableByTrait(error) ||
23
- isClockSkewCorrectedError(error) ||
24
- (error.name === "InvalidSignatureException" && error.message?.includes("Signature expired")) ||
25
- TRANSIENT_ERROR_CODES.includes(error.name) ||
26
- NODEJS_TIMEOUT_ERROR_CODES.includes(error?.code || "") ||
27
- NODEJS_NETWORK_ERROR_CODES.includes(error?.code || "") ||
28
- TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
29
- isBrowserNetworkError(error) ||
30
- isNodeJsHttp2TransientError(error) ||
31
- (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1));
22
+ export const isTransientError = (error, depth = 0) => error?.name !== "AbortError" &&
23
+ (isRetryableByTrait(error) ||
24
+ isClockSkewCorrectedError(error) ||
25
+ (error.name === "InvalidSignatureException" && error.message?.includes("Signature expired")) ||
26
+ TRANSIENT_ERROR_CODES.includes(error.name) ||
27
+ NODEJS_TIMEOUT_ERROR_CODES.includes(error?.code || "") ||
28
+ NODEJS_NETWORK_ERROR_CODES.includes(error?.code || "") ||
29
+ TRANSIENT_ERROR_STATUS_CODES.includes(error.$metadata?.httpStatusCode || 0) ||
30
+ isBrowserNetworkError(error) ||
31
+ isNodeJsHttp2TransientError(error) ||
32
+ (error.cause !== undefined && depth <= 10 && isTransientError(error.cause, depth + 1)));
32
33
  export const isServerError = (error) => {
33
34
  if (error.$metadata?.httpStatusCode !== undefined) {
34
35
  const statusCode = error.$metadata.httpStatusCode;
@@ -0,0 +1,44 @@
1
+ /**
2
+ * A general SDK error that does not fall into a more specific category.
3
+ *
4
+ * @public
5
+ */
6
+ export declare class SmithyError extends Error {
7
+ name: string;
8
+ readonly $source: string;
9
+ }
10
+ /**
11
+ * A value had the wrong type or could not be interpreted as the expected type.
12
+ *
13
+ * @public
14
+ */
15
+ export declare class SmithyTypeError extends TypeError {
16
+ name: string;
17
+ readonly $source: string;
18
+ }
19
+ /**
20
+ * A value was the correct type but fell outside its allowed range or bounds.
21
+ *
22
+ * @public
23
+ */
24
+ export declare class SmithyRangeError extends RangeError {
25
+ name: string;
26
+ readonly $source: string;
27
+ }
28
+ /**
29
+ * @public
30
+ */
31
+ export type ErrorConstructor<E extends Error = Error> = new (message?: string) => E;
32
+ /**
33
+ * @public
34
+ */
35
+ export interface ErrorContainer {
36
+ readonly $source: string;
37
+ readonly Error: ErrorConstructor<SmithyError>;
38
+ readonly TypeError: ErrorConstructor<SmithyTypeError>;
39
+ readonly RangeError: ErrorConstructor<SmithyRangeError>;
40
+ }
41
+ /**
42
+ * @public
43
+ */
44
+ export declare const errors: ErrorContainer;
@@ -0,0 +1 @@
1
+ export { errors, type SmithyError, type SmithyRangeError, type SmithyTypeError } from "./errors";
@@ -19,6 +19,10 @@ export declare const isThrottlingError: (error: SdkError) => boolean;
19
19
  * included here because there is an error scenario with unknown root
20
20
  * cause where the NodeHttpHandler does not decorate the Error with
21
21
  * the name "TimeoutError" to be checked by the TRANSIENT_ERROR_CODES condition.
22
+ *
23
+ * Errors named "AbortError" are considered terminal. AbortSignal.timeout()
24
+ * produces an underlying cause which would otherwise be considered retryable as
25
+ * a TimeoutError.
22
26
  */
23
27
  export declare const isTransientError: (error: SdkError, depth?: number) => boolean;
24
28
  export declare const isServerError: (error: SdkError) => boolean;
@@ -0,0 +1,44 @@
1
+ /**
2
+ * A general SDK error that does not fall into a more specific category.
3
+ *
4
+ * @public
5
+ */
6
+ export declare class SmithyError extends Error {
7
+ name: string;
8
+ readonly $source: string;
9
+ }
10
+ /**
11
+ * A value had the wrong type or could not be interpreted as the expected type.
12
+ *
13
+ * @public
14
+ */
15
+ export declare class SmithyTypeError extends TypeError {
16
+ name: string;
17
+ readonly $source: string;
18
+ }
19
+ /**
20
+ * A value was the correct type but fell outside its allowed range or bounds.
21
+ *
22
+ * @public
23
+ */
24
+ export declare class SmithyRangeError extends RangeError {
25
+ name: string;
26
+ readonly $source: string;
27
+ }
28
+ /**
29
+ * @public
30
+ */
31
+ export type ErrorConstructor<E extends Error = Error> = new (message?: string) => E;
32
+ /**
33
+ * @public
34
+ */
35
+ export interface ErrorContainer {
36
+ readonly $source: string;
37
+ readonly Error: ErrorConstructor<SmithyError>;
38
+ readonly TypeError: ErrorConstructor<SmithyTypeError>;
39
+ readonly RangeError: ErrorConstructor<SmithyRangeError>;
40
+ }
41
+ /**
42
+ * @public
43
+ */
44
+ export declare const errors: ErrorContainer;
@@ -0,0 +1 @@
1
+ export { errors, SmithyError, SmithyRangeError, SmithyTypeError } from "./errors";
@@ -19,6 +19,10 @@ export declare const isThrottlingError: (error: SdkError) => boolean;
19
19
  * included here because there is an error scenario with unknown root
20
20
  * cause where the NodeHttpHandler does not decorate the Error with
21
21
  * the name "TimeoutError" to be checked by the TRANSIENT_ERROR_CODES condition.
22
+ *
23
+ * Errors named "AbortError" are considered terminal. AbortSignal.timeout()
24
+ * produces an underlying cause which would otherwise be considered retryable as
25
+ * a TimeoutError.
22
26
  */
23
27
  export declare const isTransientError: (error: SdkError, depth?: number) => boolean;
24
28
  export declare const isServerError: (error: SdkError) => boolean;
package/errors.d.ts ADDED
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Do not edit:
3
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
4
+ */
5
+ export * from "./dist-types/submodules/errors/index";
package/errors.js ADDED
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Do not edit:
3
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
4
+ */
5
+ module.exports = require("./dist-cjs/submodules/errors/index.js");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smithy/core",
3
- "version": "3.33.3",
3
+ "version": "3.34.0",
4
4
  "homepage": "https://github.com/smithy-lang/smithy-typescript/tree/main/packages/core",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -24,6 +24,8 @@
24
24
  "./config.js",
25
25
  "./endpoints.d.ts",
26
26
  "./endpoints.js",
27
+ "./errors.d.ts",
28
+ "./errors.js",
27
29
  "./event-streams.d.ts",
28
30
  "./event-streams.js",
29
31
  "./protocols.d.ts",
@@ -212,6 +214,13 @@
212
214
  "node": "./dist-cjs/submodules/transport/index.js",
213
215
  "import": "./dist-es/submodules/transport/index.js",
214
216
  "require": "./dist-cjs/submodules/transport/index.js"
217
+ },
218
+ "./errors": {
219
+ "types": "./dist-types/submodules/errors/index.d.ts",
220
+ "module": "./dist-es/submodules/errors/index.js",
221
+ "node": "./dist-cjs/submodules/errors/index.js",
222
+ "import": "./dist-es/submodules/errors/index.js",
223
+ "require": "./dist-cjs/submodules/errors/index.js"
215
224
  }
216
225
  },
217
226
  "scripts": {
@@ -232,7 +241,7 @@
232
241
  "test:integration:watch": "yarn g:vitest watch -c vitest.config.integ.mts"
233
242
  },
234
243
  "dependencies": {
235
- "@smithy/types": "^4.17.2",
244
+ "@smithy/types": "^4.18.0",
236
245
  "tslib": "^2.6.2"
237
246
  },
238
247
  "devDependencies": {