SDK-3306: Error class hierarchy (#186)

This introduces the core classes for this library, namely:
- `InruptClientError`, the superclass for all Inrupt client related errors,
-  `ClientHttpError`, the base class for HTTP errors

Note that classes for specific HTTP errors (Unauthenticated, Not Found...) are not included yet, and will be added later.

`ClientHttpError` extends the base `InruptClientError` by implementing two interfaces, `WithProblemDetails` and `WithErrorResponse`, respectively associated to their type guards `hasProblemDetails` and `hasErrorResponse`. Both the `.problemDetails` and `.response` accessors are marked as read-only, and immutability is enforced at runtime for libraries not using static analysis based on TS.

The constructor of `ClientHttpError` takes in a response body and a subset of the native `Response` metadata, instead of taking a simple `Response` instance, because reading the `Response` body is an asynchronous operation, which isn't possible when building an object. It is expected that the parsing will be done by the caller in an async context, and the result will be passed to the `ClientHttpError` constructor, which is not the initial design.

For the time being, I'm not doing any submodule exports (e.g. `@inrupt/solid-client-error/http`), but this is something we might eventually consider for tree-shaking.

Co-authored-by: Pete Edwards <[email protected]>

Author: NSeydoux

.eslintrc.js

@@ -23,5 +23,22 @@ module.exports = {
   parserOptions: {
     project: "./tsconfig.eslint.json",
   },
-  ignorePatterns: ["dist/"],
+  overrides: [
+    {
+      rules: {
+        // Conflicts with TS imports
+        "import/no-unresolved": "off",
+        "no-shadow": [
+          "error",
+          {
+            // status is a (deprecated) global variable, but it also is the
+            // conventional name for a Response attribute.
+            allow: ["status"],
+          },
+        ],
+      },
+      files: "*",
+    },
+  ],
+  ignorePatterns: ["dist/", "docs/"],
 };

.github/pull_request_template.md

@@ -30,7 +30,8 @@ This PR bumps the version to <version number>.
 1. Look at the [CHANGELOG.md](../CHANGELOG.md) to determine whether the release should be a major, minor, or patch release. Coordinate with the team to ensure the next version is agreed upon.
 2. Run `npm version -- <major|minor|patch> --no-push` with the decided on version (to prevent the tag from being pushed).
 3. Update the `CHANGELOG.md` to release the latest the version, and set the release date.
-4. Commit the changes on a `release/vX.Y.Z` branch
-5. Push to GitHub, create a PR, and merge once CI passes.
-6. Create a release on GitHub for the new version, using a combination of the release notes from the `CHANGELOG.md` and the automatically generated changes.
+4. Add the `@since X.Y.Z` annotations to new APIs.
+5. Commit the changes on a `release/vX.Y.Z` branch
+6. Push to GitHub, create a PR, and merge once CI passes.
+7. Create a release on GitHub for the new version, using a combination of the release notes from the `CHANGELOG.md` and the automatically generated changes.
    The release should have a new tag matching the new version number: `vx.y.z`, and point to the release commit.

.gitignore

@@ -128,3 +128,5 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+docs/api/source/

README.md

@@ -40,7 +40,7 @@ releases](https://nodejs.org/en/about/releases/), and support 18.x and 20.x.
 
 # Installation
 
-For the latest stable version of solid-client-error:
+For the latest stable version of solid-client-errors:
 
 ```bash
 npm install @inrupt/solid-client-errors

jest.config.ts

@@ -24,7 +24,10 @@ import type { Config } from "jest";
 type ArrayElement<MyArray> = MyArray extends Array<infer T> ? T : never;
 
 const baseConfig: ArrayElement<NonNullable<Config["projects"]>> = {
+  coveragePathIgnorePatterns: [".*\\.mock\\.ts"],
   modulePathIgnorePatterns: ["dist/", "<rootDir>/examples/"],
+  // Setup required because of missing globals in JSDom
+  setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
   testRegex: "/src/.*\\.test\\.ts$",
   clearMocks: true,
   injectGlobals: false,

jest.setup.ts

@@ -0,0 +1,22 @@
+//
+// Copyright Inrupt Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal in
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+import "@inrupt/jest-jsdom-polyfills";