feat: [email protected]

Author: scalarbot

FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { ScalarCore } from "@scalar/sdk/core.js";
 import { apiDocsGetv1ApisNamespace } from "@scalar/sdk/funcs/apiDocsGetv1ApisNamespace.js";
-import { SDKValidationError } from "@scalar/sdk/models/errors/sdkvalidationerror.js";
 
 // Use `ScalarCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -33,28 +32,12 @@ async function run() {
   const res = await apiDocsGetv1ApisNamespace(scalar, {
     namespace: "<value>",
   });
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("apiDocsGetv1ApisNamespace failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

README.md

@@ -40,34 +40,30 @@ Scalar API: Public facing api to manage all scalar platform entities
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add <UNSET>
+npm add @scalar/sdk
 ```
 
 ### PNPM
 
 ```bash
-pnpm add <UNSET>
+pnpm add @scalar/sdk
 ```
 
 ### Bun
 
 ```bash
-bun add <UNSET>
+bun add @scalar/sdk
 ```
 
 ### Yarn
 
 ```bash
-yarn add <UNSET> zod
+yarn add @scalar/sdk zod
 
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
@@ -184,7 +180,6 @@ async function run() {
     namespace: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -217,7 +212,6 @@ async function run() {
     namespace: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -380,7 +374,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -411,7 +404,6 @@ async function run() {
     namespace: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -423,88 +415,45 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `getv1ApisNamespace` method may throw the following errors:
-
-| Error Type                     | Status Code | Content Type     |
-| ------------------------------ | ----------- | ---------------- |
-| errors.FourHundred             | 400         | application/json |
-| errors.FourHundredAndOne       | 401         | application/json |
-| errors.FourHundredAndThree     | 403         | application/json |
-| errors.FourHundredAndFour      | 404         | application/json |
-| errors.FourHundredAndTwentyTwo | 422         | application/json |
-| errors.FiveHundred             | 500         | application/json |
-| errors.APIError                | 4XX, 5XX    | \*/\*            |
+[`ScalarError`](./src/models/errors/scalarerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `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                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { Scalar } from "@scalar/sdk";
-import {
-  FiveHundred,
-  FourHundred,
-  FourHundredAndFour,
-  FourHundredAndOne,
-  FourHundredAndThree,
-  FourHundredAndTwentyTwo,
-  SDKValidationError,
-} from "@scalar/sdk/models/errors";
+import * as errors from "@scalar/sdk/models/errors";
 
 const scalar = new Scalar({
   bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-  let result;
   try {
-    result = await scalar.apiDocs.getv1ApisNamespace({
+    const result = await scalar.apiDocs.getv1ApisNamespace({
       namespace: "<value>",
     });
 
-    // Handle the result
     console.log(result);
-  } catch (err) {
-    switch (true) {
-      // The server response does not match the expected SDK schema
-      case (err instanceof SDKValidationError): {
-        // Pretty-print will provide a human-readable multi-line error message
-        console.error(err.pretty());
-        // Raw value may also be inspected
-        console.error(err.rawValue);
-        return;
-      }
-      case (err instanceof FourHundred): {
-        // Handle err.data$: FourHundredData
-        console.error(err);
-        return;
-      }
-      case (err instanceof FourHundredAndOne): {
-        // Handle err.data$: FourHundredAndOneData
-        console.error(err);
-        return;
-      }
-      case (err instanceof FourHundredAndThree): {
-        // Handle err.data$: FourHundredAndThreeData
-        console.error(err);
-        return;
-      }
-      case (err instanceof FourHundredAndFour): {
-        // Handle err.data$: FourHundredAndFourData
-        console.error(err);
-        return;
-      }
-      case (err instanceof FourHundredAndTwentyTwo): {
-        // Handle err.data$: FourHundredAndTwentyTwoData
-        console.error(err);
-        return;
-      }
-      case (err instanceof FiveHundred): {
-        // Handle err.data$: FiveHundredData
-        console.error(err);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.ScalarError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.FourHundred) {
+        console.log(error.data$.message); // string
+        console.log(error.data$.code); // string
       }
     }
   }
@@ -514,17 +463,32 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### Error Classes
+**Primary errors:**
+* [`ScalarError`](./src/models/errors/scalarerror.ts): The base class for HTTP error responses.
+  * [`FourHundred`](docs/models/errors/fourhundred.md): Bad request. Status code `400`.
+  * [`FourHundredAndOne`](docs/models/errors/fourhundredandone.md): No auth. Status code `401`.
+  * [`FourHundredAndThree`](docs/models/errors/fourhundredandthree.md): Forbidden. Status code `403`.
+  * [`FourHundredAndFour`](docs/models/errors/fourhundredandfour.md): Not found. Status code `404`.
+  * [`FourHundredAndTwentyTwo`](docs/models/errors/fourhundredandtwentytwo.md): Invalid payload. Status code `422`.
+  * [`FiveHundred`](docs/models/errors/fivehundred.md): Uncaught error. 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.
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
 
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+**Inherit from [`ScalarError`](./src/models/errors/scalarerror.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] -->
@@ -546,7 +510,6 @@ async function run() {
     namespace: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 

USAGE.md

@@ -11,7 +11,6 @@ async function run() {
     namespace: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }