nuki-api-js 1.1.1 → 3.0.1

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) SferaDev
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -27,6 +27,12 @@ const accounts = await client.api.account.getAccountsResource({});
 
 Operations are grouped by tag: `client.api.<tag>.<operation>(params)`.
 
+Every operation can also be called by method and path:
+
+```ts
+const accounts = await client.request("GET /account");
+```
+
 ### Custom fetch
 
 ```ts
@@ -36,22 +42,26 @@ const client = new NukiApi({
 });
 ```
 
+## Errors
+
+A call that gets an HTTP error response rejects with `{ status, payload }`: `status` is the HTTP status code and `payload` is the parsed JSON error body, or the raw body text, up to 1000 characters, when it is not JSON. A request that gets no response at all, for example because the network failed, rejects with an `Error` whose message names the method, the path and the reason, and whose `cause` is the original exception. A request cancelled through `signal` rejects with what the signal was aborted with, as is: the `AbortError`, or the `TimeoutError` of `AbortSignal.timeout()`.
+
 ## Effect
 
-The `effect` entrypoint exposes every operation as an `Effect`. It requires `effect` as a peer dependency.
+The `effect` entrypoint exposes every operation as an `Effect`. It requires `effect` 4 as a peer dependency.
 
 ```ts
 import { Effect } from "effect";
 import { ApiService, makeApiLayer } from "nuki-api-js/effect";
 
-const program = ApiService.account.getAccountsResource({});
+const program = ApiService.account.getAccountsResource();
 
 await Effect.runPromise(
   program.pipe(Effect.provide(makeApiLayer({ token: process.env.NUKI_TOKEN })))
 );
 ```
 
-Errors are typed as `ApiError`, `NetworkError` and `ValidationError`.
+Errors are typed as `ApiError`, `NetworkError` and `ValidationError`. An HTTP error response fails with `ApiError`, which carries the HTTP `status`; a request that never gets a response fails with `NetworkError`.
 
 ## Entrypoints