@noresponse/node 7.1.1 → 7.1.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 7.1.3
+
+No changes detected.
+
+## 7.1.2
+
+No changes detected.
+
 ## 7.1.1
 
 * `sdk.accounts.recordEnforcement()`: 

package/README.md

@@ -1,10 +1,14 @@
-<img src="https://raw.githubusercontent.com/noresponsehq/.github/main/profile/sdk-header.png" alt="NoResponse" width="100%">
+<a href="https://noresponse.org"><img src="https://raw.githubusercontent.com/noresponsehq/.github/main/profile/sdk-header.png" alt="NoResponse · Identity Intelligence" width="100%"></a>
 
-# @noresponse/node
+# NoResponse for TypeScript and Node.js
 
-The NoResponse client for Node.js. It assesses an account creation, login or purchase, polls a pending assessment, pages through an account's history, records what you later learned, rotates your API key and verifies webhooks.
+Assess sign-ups, logins and purchases with the NoResponse Identity Intelligence API.
 
-Node.js 20 or later. ESM and CommonJS. TypeScript types included. The client is generated from the NoResponse OpenAPI document; webhooks, auth adapters and the wait helper are hand-written.
+Node.js 20+ · ESM and CommonJS · TypeScript types included.
+
+[Documentation](https://docs.noresponse.org/sdks/typescript) · [API reference](https://docs.noresponse.org/api-reference) · [Releases](https://github.com/noresponsehq/node/releases)
+
+## Install
 
 ```sh
 npm install @noresponse/node
@@ -34,6 +38,19 @@ if (assessment.account) {
 
 Keep the API key on your server. The client throws at construction without one.
 
+## Go further
+
+| Task | Guide |
+| --- | --- |
+| Configure this client and explore its methods | [TypeScript and Node.js SDK guide](https://docs.noresponse.org/sdks/typescript) |
+| Act when an account's decision changes | [Late results](https://docs.noresponse.org/guides/late-results) |
+| Explore request and response fields | [API reference](https://docs.noresponse.org/api-reference) |
+
+<details>
+<summary><strong>SDK reference</strong> · configuration, methods, errors and webhooks</summary>
+
+[Configuration](#configuration) · [Assessments](#assessments) · [Keys](#keys) · [Integrations](#integrations) · [Response metadata](#response-metadata) · [Errors](#errors) · [Retries](#retries) · [Issued keys](#issued-keys) · [Key usage](#key-usage) · [Webhooks](#webhooks) · [Auth adapters](#auth-adapters) · [Logging](#logging) · [Standalone functions](#standalone-functions)
+
 ## Configuration
 
 ```ts
@@ -348,7 +365,7 @@ if (result.riskVersion !== undefined) await users.update(result.account!.id, { e
 | `active` | `login` | `block` | `restrict`, `revoke_sessions` |
 | `restricted` | `login` | `allow` | `unrestrict`, only with `reinstate` |
 
-Nothing deletes a user. Clerk bans (and unbans), Auth0 sets `blocked`, and WorkOS, which has no block, writes `noresponse_state` to the user's metadata (gate sign-in on it) and revokes every session. On an Auth0 plan without the sessions API the revoke blocks the user too and reports `restrict`. Each action, or `none` when nothing is needed, is recorded with `accounts.recordEnforcement` at the `riskVersion` read, and `result.enforcements` lists them. A refused action is recorded as `failed` and throws `ProviderActionError`: answer 5xx so the delivery is retried. A test event, an erased account and an account at or below `enforcedRiskVersion` act on nothing (`result.skipped`). To catch up after dropped deliveries, pass each account of `nr.accounts.listChanged({ unenforced: true })` to `enforceAccount`. For your own user store, `customProvider({ restrict: async (userId) => ..., revoke_sessions: async (userId) => ... })` takes one function per action you support; an action without one is recorded as failed.
+Nothing deletes a user. Clerk bans (and unbans), Auth0 sets `blocked`, and WorkOS, which has no block on a user, writes `noresponse_state` to the user's metadata (gate sign-in on it) and revokes every session. On an Auth0 plan without the sessions API the revoke blocks the user too and reports `restrict`. Each action, or `none` when nothing is needed, is recorded with `accounts.recordEnforcement` at the `riskVersion` read, and `result.enforcements` lists them. A refused action is recorded as `failed` and throws `ProviderActionError`: answer 5xx so the delivery is retried. A test event, an erased account and an account at or below `enforcedRiskVersion` act on nothing (`result.skipped`). To catch up after dropped deliveries, pass each account of `nr.accounts.listChanged({ unenforced: true })` to `enforceAccount`. For your own user store, `customProvider({ restrict: async (userId) => ..., revoke_sessions: async (userId) => ... })` takes one function per action you support; an action without one is recorded as failed.
 
 A held flow (workspace settings `admission: held`) answers `held` until its investigation completes or `hold_seconds` pass, and the handler records `none` for it. When the final decision arrives as `account.risk_changed`, an `onboarding` or `provisional` account fails onboarding or is refused activation on `review` or `block`. On `allow` the handler records `activate` (no provider call; a custom provider runs its own `activate`), so admit the account when the result's enforcements hold it. An account at `allow` that needs no change, such as an `active` one after a held login, is recorded as `none`. Either way the account leaves the unenforced list. See https://docs.noresponse.org/guides/late-results.
 
@@ -384,8 +401,11 @@ const result = await assessmentsCreate(new NoResponseCore({ apiKey }), { idempot
 if (result.ok) console.log(result.value.result.status);
 ```
 
+</details>
+
 ## Support
 
-Documentation: https://docs.noresponse.org. Issues: https://github.com/noresponsehq/node/issues. Quote `meta.requestId` or `error.requestId` when you write to us.
+[Open an issue](https://github.com/noresponsehq/node/issues) and include the request ID from the response or error.
+Keep API keys and personal data out of issues.
 
-Apache-2.0.
+[Apache-2.0](LICENSE).

package/dist/commonjs/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "1";
-    readonly sdkVersion: "7.1.1";
+    readonly sdkVersion: "7.1.3";
     readonly genVersion: "internal";
-    readonly userAgent: "noresponse-sdk/typescript 7.1.1 internal 1 @noresponse/node";
+    readonly userAgent: "noresponse-sdk/typescript 7.1.3 internal 1 @noresponse/node";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/commonjs/lib/config.js

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1",
-    sdkVersion: "7.1.1",
+    sdkVersion: "7.1.3",
     genVersion: "internal",
-    userAgent: "noresponse-sdk/typescript 7.1.1 internal 1 @noresponse/node",
+    userAgent: "noresponse-sdk/typescript 7.1.3 internal 1 @noresponse/node",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/lib/config.d.ts

@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "1";
-    readonly sdkVersion: "7.1.1";
+    readonly sdkVersion: "7.1.3";
     readonly genVersion: "internal";
-    readonly userAgent: "noresponse-sdk/typescript 7.1.1 internal 1 @noresponse/node";
+    readonly userAgent: "noresponse-sdk/typescript 7.1.3 internal 1 @noresponse/node";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -24,8 +24,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1",
-    sdkVersion: "7.1.1",
+    sdkVersion: "7.1.3",
     genVersion: "internal",
-    userAgent: "noresponse-sdk/typescript 7.1.1 internal 1 @noresponse/node",
+    userAgent: "noresponse-sdk/typescript 7.1.3 internal 1 @noresponse/node",
 };
 //# sourceMappingURL=config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noresponse/node",
-  "version": "7.1.1",
+  "version": "7.1.3",
   "author": "NoResponse",
   "bugs": {
     "url": "https://github.com/noresponsehq/node/issues"