dub 0.62.3 → 0.63.0

package/README.md

@@ -295,16 +295,15 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-This table shows properties which are common on error classes. For full details see [error classes](#error-classes).
+[`DubError`](./src/models/errors/duberror.ts) is the base class for all HTTP error responses. It has the following properties:
 
 | Property            | Type       | Description                                                                             |
 | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
-| `error.name`        | `string`   | Error class name eg `SDKError`                                                          |
 | `error.message`     | `string`   | Error message                                                                           |
-| `error.statusCode`  | `number`   | HTTP status code eg `404`                                                               |
-| `error.contentType` | `string`   | HTTP content type eg `application/json`                                                 |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
 | `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
-| `error.rawResponse` | `Response` | Raw HTTP response. Access to headers and more.                                          |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
 | `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
 ### Example
@@ -322,18 +321,17 @@ async function run() {
 
     console.log(result);
   } catch (error) {
-    // Depending on the method different errors may be thrown
-    if (error instanceof errors.BadRequest) {
-      console.log(error.message);
-      console.log(error.data$.error); // errors.ErrorT
-    }
-
-    // Fallback error class, if no other more specific error class is matched
-    if (error instanceof errors.SDKError) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.DubError) {
       console.log(error.message);
       console.log(error.statusCode);
       console.log(error.body);
-      console.log(error.rawResponse.headers);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.BadRequest) {
+        console.log(error.data$.error); // errors.ErrorT
+      }
     }
   }
 }
@@ -343,23 +341,34 @@ run();
 ```
 
 ### Error Classes
-* [`BadRequest`](docs/models/errors/badrequest.md): The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). Status code `400`.
-* [`Unauthorized`](docs/models/errors/unauthorized.md): Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. Status code `401`.
-* [`Forbidden`](docs/models/errors/forbidden.md): The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. Status code `403`.
-* [`NotFound`](docs/models/errors/notfound.md): The server cannot find the requested resource. Status code `404`.
-* [`Conflict`](docs/models/errors/conflict.md): This response is sent when a request conflicts with the current state of the server. Status code `409`.
-* [`InviteExpired`](docs/models/errors/inviteexpired.md): This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Status code `410`.
-* [`UnprocessableEntity`](docs/models/errors/unprocessableentity.md): The request was well-formed but was unable to be followed due to semantic errors. Status code `422`.
-* [`RateLimitExceeded`](docs/models/errors/ratelimitexceeded.md): The user has sent too many requests in a given amount of time ("rate limiting"). Status code `429`.
-* [`InternalServerError`](docs/models/errors/internalservererror.md): The server has encountered a situation it does not know how to handle. Status code `500`.
-* `SDKError`: The fallback error class, if no other more specific error class is matched.
-* `SDKValidationError`: Type mismatch between the data returned from the server and the structure expected by the SDK. This can also be thrown for invalid method arguments. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
-* Network errors:
-    * `ConnectionError`: HTTP client was unable to make a request to a server.
-    * `RequestTimeoutError`: HTTP request timed out due to an AbortSignal signal.
-    * `RequestAbortedError`: HTTP request was aborted by the client.
-    * `InvalidRequestError`: Any input used to create a request is invalid.
-    * `UnexpectedClientError`: Unrecognised or unexpected error.
+**Primary errors:**
+* [`DubError`](./src/models/errors/duberror.ts): The base class for HTTP error responses.
+  * [`BadRequest`](docs/models/errors/badrequest.md): The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). Status code `400`.
+  * [`Unauthorized`](docs/models/errors/unauthorized.md): Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. Status code `401`.
+  * [`Forbidden`](docs/models/errors/forbidden.md): The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. Status code `403`.
+  * [`NotFound`](docs/models/errors/notfound.md): The server cannot find the requested resource. Status code `404`.
+  * [`Conflict`](docs/models/errors/conflict.md): This response is sent when a request conflicts with the current state of the server. Status code `409`.
+  * [`InviteExpired`](docs/models/errors/inviteexpired.md): This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Status code `410`.
+  * [`UnprocessableEntity`](docs/models/errors/unprocessableentity.md): The request was well-formed but was unable to be followed due to semantic errors. Status code `422`.
+  * [`RateLimitExceeded`](docs/models/errors/ratelimitexceeded.md): The user has sent too many requests in a given amount of time ("rate limiting"). Status code `429`.
+  * [`InternalServerError`](docs/models/errors/internalservererror.md): The server has encountered a situation it does not know how to handle. Status code `500`.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`DubError`](./src/models/errors/duberror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->