@noresponse/node 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 NoResponse
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @noresponse/node
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Server-side Node / TypeScript client for the provider-facing NoResponse signup API. Install it with `npm install @noresponse/node` (Node 20 or later). To work on the SDK, run `npm ci && npm test` in this folder; builds emit `dist/index.js` and type declarations.
+
+```ts
+import { NoResponse, type Assessment } from "@noresponse/node";
+
+const nr = new NoResponse({
+  apiKey: process.env.NORESPONSE_API_KEY!,       // server-only
+  baseUrl: process.env.NORESPONSE_API_URL!,     // https://api.noresponse.org in production
+  timeoutMs: 5000,                              // transport timeout; configurable per deployment
+});
+const assessment: Assessment = await nr.assess({
+  accountId: "usr_123",
+  email: "person@example.com",                  // email, username or phone: at least one
+  name: "Jane A. Doe",                          // optional, used only for matching
+  ip: "73.162.18.45",                           // optional, the signup's public IP
+  idempotencyKey: "signup-usr_123-0000001",
+});
+if (assessment.status === "pending") {
+  // No recommendation yet: never allow. Apply YOUR fallback, then wait for the webhook or poll.
+} else if (assessment.risk?.recommendation === "step_up") {
+  // Your app decides whether to request an additional verification step.
+}
+```
+
+Also provides `getAssessment(assessmentId, { responseMode })` and `queryAssessments({ account_id, limit, cursor, responseMode })`. `responseMode: "detailed"` (with the `detailed` key scope) adds `risk.details` and `signals[]`; `raw` is refused.
+
+Webhooks: `verifyWebhook(rawBody, headerPairs, secrets, nowSeconds?)` checks the `v1=` HMAC-SHA256 signature over the exact raw request bytes, the 300-second timestamp window and the event id, and returns the typed `WebhookEvent`. It takes **raw header pairs** so it can refuse a repeated header, including a case variant. Never parse then re-stringify the body before verifying. An `assessment.updated` event's `data` is the full assessment, exactly as `getAssessment` returns it: `webhookAssessment(event)` returns it as a typed `Assessment`. Keep the highest `assessment_version` per assessment. When receiving `endpoint.verification`, respond with `webhookVerificationResponse(event)`.
+
+See [example rules](../docs/example-rules.md) for turning an assessment into an action, for example "step up when `breach_name_mismatch` or `proxy_ip` fired".
+
+This SDK never makes the allow/deny decision for a provider. `pending`, HTTP 429/503 and network timeouts must follow provider-defined fail-open/step-up policy; idempotency keys must be reused for retries of the **same request body**. No tenant keys in browser bundles, environment values in logs, or production traffic before the API release GO decision.
+
+Every request, response, summary, detail, signal and webhook type is generated from the provider OpenAPI contract into `src/generated/models.ts` and re-exported from the package (for example `Assessment`, `Risk`, `RiskReason`, `RiskSummary`, `Signal`, `WebhookEvent`). The committed package-lock.json makes the TypeScript toolchain reproducible; use npm ci in CI and local validation. See [provider onboarding](../docs/provider-onboarding.md) for key rotation, webhook verification, retries and staging setup.

package/dist/generated/models.d.ts

@@ -0,0 +1,248 @@
+export type AssessmentRequest = {
+    account_id: string;
+    identifiers: AssessmentRequestIdentifiers;
+    policy_context?: AssessmentRequestPolicyContext;
+    request_id?: string;
+    deadline_ms?: number;
+    response_mode?: AssessmentRequestResponseMode;
+};
+export type AssessmentRequestIdentifiers = {
+    email?: string;
+    username?: string;
+    phone?: string;
+    name?: string;
+    ip?: string;
+};
+export type AssessmentRequestPolicyContext = {
+    flow?: AssessmentRequestPolicyContextFlow;
+    region?: string;
+};
+export type AssessmentRequestPolicyContextFlow = "signup" | "login" | "recovery" | "profile_change";
+export type AssessmentRequestResponseMode = "standard" | "detailed";
+export type Assessment = {
+    schema_version: "1";
+    assessment_id: string;
+    account_id: string;
+    request_id?: string;
+    status: Status;
+    recommendation?: Recommendation;
+    confidence: Confidence;
+    risk?: Risk;
+    signals?: Signal[];
+    incomplete_sources: IncompleteSource[];
+    policy_version: string;
+    policy_basis: "heuristic_unvalidated";
+    assessment_version: number;
+    created_at: string;
+    updated_at: string;
+    expires_at: string;
+    assessment_url?: string;
+    timing: AssessmentTiming;
+};
+export type Status = "complete" | "partial" | "pending";
+export type Recommendation = "allow" | "step_up" | "review";
+export type Confidence = "low" | "medium" | "high" | "unavailable";
+export type Risk = {
+    score: number;
+    band: RiskBand;
+    recommendation: Recommendation;
+    confidence: RiskConfidence;
+    policy_version: string;
+    policy_basis: "heuristic_unvalidated";
+    reasons: RiskReason[];
+    summary?: RiskSummary;
+    coverage: RiskCoverage;
+    details?: RiskDetails;
+};
+export type RiskBand = "low" | "medium" | "high" | "critical";
+export type RiskConfidence = "low" | "medium" | "high";
+export type RiskReason = {
+    code: ReasonCode;
+    weight: number;
+    identifier?: ReasonIdentifier;
+};
+export type ReasonCode = "no_digital_footprint" | "voip_number" | "disposable_email" | "new_email" | "spam_reports" | "fraud_flag" | "identity_mismatch" | "country_mismatch" | "proxy_ip" | "seen_before" | "shared_ip" | "many_recent_signups" | "whatsapp_absent" | "established_accounts" | "aged_identity" | "breach_name_match" | "breach_cooccurrence" | "breach_name_mismatch" | "breach_phone_mismatch" | "recent_password_exposure" | "credential_list_exposure" | "abuse_ecosystem_member" | "no_breach_history";
+export type ReasonIdentifier = "email" | "username" | "phone" | "name" | "ip";
+export type RiskSummary = {
+    phone?: RiskSummaryPhone;
+    email?: RiskSummaryEmail;
+    username?: RiskSummaryUsername;
+    ip?: IpSummary;
+    consistency?: Consistency;
+};
+export type RiskSummaryPhone = {
+    line_type?: RiskSummaryPhoneLineType;
+    country?: string;
+    on_whatsapp?: boolean;
+    report_count?: number;
+    carrier?: string;
+};
+export type RiskSummaryPhoneLineType = "mobile" | "voip" | "landline" | "toll_free" | "other";
+export type RiskSummaryEmail = {
+    disposable?: boolean;
+    accounts_found?: number;
+    breach?: BreachSummary;
+};
+export type BreachSummary = {
+    found: boolean;
+    breach_count?: number;
+    first_year?: number;
+    last_year?: number;
+    exposed?: BreachExposed[];
+    in_credential_lists?: boolean;
+    recent_password_exposure?: boolean;
+    truncated?: boolean;
+};
+export type BreachExposed = "email" | "username" | "name" | "password" | "password_hash" | "phone" | "address" | "dob" | "ip" | "payment" | "security_qa";
+export type RiskSummaryUsername = {
+    accounts_found?: number;
+    breach?: BreachSummary;
+};
+export type IpSummary = {
+    country?: string;
+    type?: IpSummaryType;
+    seen_in_tenant?: number;
+};
+export type IpSummaryType = "residential" | "hosting" | "vpn" | "proxy" | "tor" | "mobile" | "unknown";
+export type Consistency = {
+    name?: ConsistencyValue;
+    phone?: ConsistencyValue;
+    ip?: ConsistencyValue;
+    country?: ConsistencyCountry;
+};
+export type ConsistencyValue = "match" | "partial" | "mismatch" | "unknown";
+export type ConsistencyCountry = "consistent" | "mismatch" | "unknown";
+export type RiskCoverage = {
+    answered: number;
+    failed: number;
+    pending: number;
+};
+export type RiskDetails = {
+    phone_names?: RiskDetailsPhoneName[];
+    breaches?: Breach[];
+    breach_names?: RiskDetailsBreachName[];
+};
+export type RiskDetailsPhoneName = {
+    value: string;
+    seen_by: number;
+};
+export type Breach = {
+    name: string;
+    domain?: string;
+    category?: string;
+    kind: BreachKind;
+    year?: number;
+    month?: number;
+    matched_on: BreachSelector;
+    exposed?: BreachExposed[];
+};
+export type BreachKind = "site_breach" | "credential_list" | "stealer_log" | "scrape" | "hacking_forum" | "abuse_service" | "darkweb_site";
+export type BreachSelector = "email" | "username" | "ip";
+export type RiskDetailsBreachName = {
+    value: string;
+    seen_in: number;
+};
+export type Signal = {
+    type: string;
+    identifier: IdentifierKind;
+    outcome: SignalOutcome;
+    source_id: string;
+    reason?: FailureReason;
+    evidence_ref?: string;
+    observed_at?: string;
+    last_checked_at?: string;
+    freshness: Freshness;
+    enrichment?: PhoneEnrichment;
+};
+export type IdentifierKind = "email" | "username" | "phone" | "ip";
+export type SignalOutcome = "found" | "not_found" | "inconclusive" | "blocked" | "unavailable";
+export type FailureReason = "timed_out" | "rate_limited" | "blocked" | "source_error" | "unavailable" | "deferred" | "insufficient_evidence";
+export type Freshness = "fresh" | "stale" | "unknown";
+export type PhoneEnrichment = {
+    fields: PhoneEnrichmentFields;
+};
+export type PhoneEnrichmentFields = {
+    phone?: string;
+    name?: string;
+    carrier?: string;
+    line_type?: string;
+    entity_type?: string;
+    country_code?: string;
+    country?: string;
+    state?: string;
+    city?: string;
+    location?: string;
+    national_format?: string;
+    job_title?: string;
+    company_name?: string;
+    email?: string;
+    website?: string;
+    first_call_at?: string;
+    last_call_at?: string;
+    matched_name?: string;
+    alternate_names?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    name_candidates?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    timezones?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    emails?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    websites?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    locations?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    social_profiles?: Array<string | number | boolean | Record<string, unknown> | unknown[]>;
+    report_count?: number;
+    tag_count?: number;
+    total_calls?: number;
+    calls_60_days?: number;
+    reports_60_days?: number;
+    searches_60_days?: number;
+    comment_count?: number;
+    names_count?: number;
+    spam_report_count?: number;
+};
+export type IncompleteSource = {
+    lane: Lane;
+    reason: IncompleteReason;
+};
+export type Lane = "accounts" | "phone" | "breach" | "ip";
+export type IncompleteReason = "timed_out" | "rate_limited" | "blocked" | "source_error" | "unavailable" | "deferred";
+export type AssessmentTiming = {
+    deadline_ms: number;
+    elapsed_ms: number;
+};
+export type AssessmentList = {
+    schema_version: "1";
+    account_id: string;
+    items: Assessment[];
+    next_cursor?: string;
+    retention_days: number;
+};
+export type WebhookEvent = {
+    id: string;
+    type: WebhookEventType;
+    created_at: string;
+    data: unknown;
+};
+export type WebhookEventType = "assessment.updated" | "endpoint.verification";
+export type Problem = {
+    type: string;
+    title: string;
+    status: number;
+    detail: string;
+    instance?: string;
+    code: string;
+    request_id: string;
+    invalid_params?: ProblemInvalidParam[];
+};
+export type ProblemInvalidParam = {
+    field: string;
+    reason: string;
+    example?: string;
+};
+export type AssessmentQuery = {
+    account_id: string;
+    limit?: number;
+    cursor?: string;
+    response_mode?: AssessmentQueryResponseMode;
+};
+export type AssessmentQueryResponseMode = "standard" | "detailed";
+export type WebhookVerificationResponse = {
+    challenge: string;
+};

package/dist/generated/models.js

@@ -0,0 +1,2 @@
+/* GENERATED FILE. Run python3 sdks/tools/generate_models.py to update. */
+export {};

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+/** Server-side NoResponse signup client. Never expose the API key in browser code. */
+import type { Assessment, AssessmentList, AssessmentQuery, AssessmentRequest } from "./generated/models.js";
+export type * from "./generated/models.js";
+export { verifyWebhook, webhookAssessment, webhookVerificationResponse } from "./webhooks.js";
+/** standard or detailed; raw is never served. Derived from the generated request type. */
+export type ResponseMode = NonNullable<AssessmentRequest["response_mode"]>;
+export declare class NoResponseError extends Error {
+    readonly status: number;
+    readonly type?: string | undefined;
+    readonly code?: string | undefined;
+    readonly detail?: string | undefined;
+    constructor(status: number, message: string, type?: string | undefined, code?: string | undefined, detail?: string | undefined);
+}
+export declare class NoResponse {
+    private readonly config;
+    private readonly baseUrl;
+    constructor(config: {
+        apiKey: string;
+        baseUrl: string;
+        fetch?: typeof fetch;
+        timeoutMs?: number;
+    });
+    assess(input: {
+        accountId: string;
+        email?: string;
+        username?: string;
+        phone?: string;
+        /** Full name as typed. Used only for matching; never looked up. Needs email, username or phone. */
+        name?: string;
+        /** Signup IPv4 or IPv6 address (public ranges only). Needs email, username or phone. */
+        ip?: string;
+        requestId?: string;
+        region?: string;
+        deadlineMs?: number;
+        responseMode?: ResponseMode;
+        idempotencyKey: string;
+    }): Promise<Assessment>;
+    getAssessment(assessmentId: string, options?: {
+        responseMode?: ResponseMode;
+    }): Promise<Assessment>;
+    queryAssessments(query: AssessmentQuery & {
+        responseMode?: ResponseMode;
+    }): Promise<AssessmentList>;
+    private request;
+}

package/dist/index.js

@@ -0,0 +1,126 @@
+export { verifyWebhook, webhookAssessment, webhookVerificationResponse } from "./webhooks.js";
+const LOOKUP_IDENTIFIERS = ["email", "username", "phone"];
+const MATCH_IDENTIFIERS = ["name", "ip"];
+export class NoResponseError extends Error {
+    status;
+    type;
+    code;
+    detail;
+    constructor(status, message, type, code, detail) {
+        super(message);
+        this.status = status;
+        this.type = type;
+        this.code = code;
+        this.detail = detail;
+        this.name = "NoResponseError";
+    }
+}
+export class NoResponse {
+    config;
+    baseUrl;
+    constructor(config) {
+        this.config = config;
+        if (!config.apiKey)
+            throw new Error("NoResponse API key required");
+        if (config.timeoutMs !== undefined && (!Number.isInteger(config.timeoutMs) || config.timeoutMs <= 0)) {
+            throw new Error("timeoutMs must be a positive integer");
+        }
+        const url = new URL(config.baseUrl);
+        if (url.search || url.hash || /[?#]$/.test(config.baseUrl)) {
+            throw new Error("baseUrl must not include a query or fragment");
+        }
+        if (url.protocol !== "https:" && url.hostname !== "localhost" && url.hostname !== "127.0.0.1") {
+            throw new Error("NoResponse requires HTTPS outside localhost");
+        }
+        this.baseUrl = url.toString().replace(/\/$/, "");
+    }
+    async assess(input) {
+        const identifiers = {};
+        for (const key of LOOKUP_IDENTIFIERS)
+            if (input[key] !== undefined)
+                identifiers[key] = input[key];
+        if (!Object.keys(identifiers).length)
+            throw new Error("At least one of email, username or phone required");
+        for (const key of MATCH_IDENTIFIERS)
+            if (input[key] !== undefined)
+                identifiers[key] = input[key];
+        if (input.name !== undefined && (input.name.length < 1 || input.name.length > 128))
+            throw new Error("name must be 1-128 characters");
+        if (!/^[A-Za-z0-9._:-]{16,128}$/.test(input.idempotencyKey))
+            throw new Error("Valid 16-128 character idempotencyKey required");
+        const body = { account_id: input.accountId, identifiers: identifiers };
+        if (input.requestId !== undefined)
+            body.request_id = input.requestId;
+        if (input.deadlineMs !== undefined) {
+            if (!Number.isInteger(input.deadlineMs) || input.deadlineMs < 50 || input.deadlineMs > 500)
+                throw new Error("deadlineMs must be 50–500");
+            body.deadline_ms = input.deadlineMs;
+        }
+        if (input.region !== undefined)
+            body.policy_context = { flow: "signup", region: input.region };
+        if (input.responseMode !== undefined) {
+            if (input.responseMode !== "standard" && input.responseMode !== "detailed")
+                throw new Error("responseMode must be standard or detailed; raw is never served");
+            body.response_mode = input.responseMode;
+        }
+        return this.request("/v1/assessments", { method: "POST", body: JSON.stringify(body), headers: { "Idempotency-Key": input.idempotencyKey } });
+    }
+    async getAssessment(assessmentId, options = {}) {
+        if (!/^asm_[0-9A-HJKMNP-TV-Z]{26}$/.test(assessmentId))
+            throw new Error("Invalid assessment ID");
+        if (options.responseMode !== undefined && options.responseMode !== "standard" && options.responseMode !== "detailed")
+            throw new Error("responseMode must be standard or detailed");
+        const suffix = options.responseMode ? `?response_mode=${options.responseMode}` : "";
+        return this.request(`/v1/assessments/${assessmentId}${suffix}`, { method: "GET" });
+    }
+    async queryAssessments(query) {
+        if (!query.account_id || (query.limit !== undefined && (!Number.isInteger(query.limit) || query.limit < 1 || query.limit > 50)))
+            throw new Error("Invalid assessment query");
+        if (query.responseMode !== undefined && query.response_mode !== undefined)
+            throw new Error("Supply only one response mode");
+        const mode = query.responseMode ?? query.response_mode;
+        if (mode !== undefined && mode !== "standard" && mode !== "detailed")
+            throw new Error("responseMode must be standard or detailed; raw is never served");
+        const body = { account_id: query.account_id };
+        if (query.limit !== undefined)
+            body.limit = query.limit;
+        if (query.cursor !== undefined)
+            body.cursor = query.cursor;
+        if (mode !== undefined)
+            body.response_mode = mode;
+        return this.request("/v1/assessments/query", { method: "POST", body: JSON.stringify(body) });
+    }
+    async request(path, options) {
+        const transport = this.config.fetch ?? fetch;
+        const response = await transport(this.baseUrl + path, {
+            method: options.method,
+            headers: {
+                Authorization: `Bearer ${this.config.apiKey}`,
+                Accept: "application/json",
+                ...(options.body ? { "Content-Type": "application/json" } : {}),
+                ...options.headers,
+            },
+            body: options.body,
+            signal: AbortSignal.timeout(this.config.timeoutMs ?? 5000),
+        });
+        if (!response.ok) {
+            let problem = {};
+            try {
+                const parsed = await response.json();
+                if (parsed !== null && typeof parsed === "object") {
+                    const body = parsed;
+                    problem = {
+                        ...(typeof body.type === "string" ? { type: body.type } : {}),
+                        ...(typeof body.code === "string" ? { code: body.code } : {}),
+                        ...(typeof body.detail === "string" ? { detail: body.detail } : {}),
+                    };
+                }
+            }
+            catch {
+                // Preserve NoResponseError when the error body is empty or invalid JSON.
+            }
+            throw new NoResponseError(response.status, `NoResponse request failed (HTTP ${response.status})`, problem.type, problem.code, problem.detail);
+        }
+        return response.json();
+    }
+}

package/dist/webhooks.d.ts

@@ -0,0 +1,17 @@
+import type { Assessment, WebhookEvent } from "./generated/models.js";
+/**
+ * Verify a delivery against the raw request bytes and return the typed event.
+ * Header pairs retain duplicates, so a repeated or case-variant header is refused.
+ * For assessment.updated, `data` is the assessment exactly as GET returns it;
+ * webhookAssessment(event) returns it as a typed Assessment.
+ */
+export declare function verifyWebhook(rawBody: Uint8Array, headerPairs: ReadonlyArray<readonly [string, string]>, secrets: Readonly<Record<string, string | Uint8Array>>, nowSeconds?: number): WebhookEvent;
+/**
+ * The typed assessment carried by a verified assessment.updated event. Throws for
+ * any other event, and for data that is not a full assessment (for example an
+ * expiry notice or a pre-v1 pointer payload).
+ */
+export declare function webhookAssessment(event: WebhookEvent): Assessment;
+export declare function webhookVerificationResponse(event: WebhookEvent): {
+    challenge: string;
+};

package/dist/webhooks.js

@@ -0,0 +1,87 @@
+import { createHmac, timingSafeEqual } from "node:crypto";
+const EVENT_TYPES = new Set(["assessment.updated", "endpoint.verification"]);
+function isRecord(value) {
+    return value !== null && typeof value === "object" && !Array.isArray(value);
+}
+/** The envelope fields, read from the v1 names (id, type) or the earlier event_id/event_type. */
+function envelope(event) {
+    const body = isRecord(event) ? event : {};
+    return { id: body.id ?? body.event_id, type: body.type ?? body.event_type, data: body.data };
+}
+/**
+ * Verify a delivery against the raw request bytes and return the typed event.
+ * Header pairs retain duplicates, so a repeated or case-variant header is refused.
+ * For assessment.updated, `data` is the assessment exactly as GET returns it;
+ * webhookAssessment(event) returns it as a typed Assessment.
+ */
+export function verifyWebhook(rawBody, headerPairs, secrets, nowSeconds = Math.floor(Date.now() / 1000)) {
+    const required = ["nr-webhook-id", "nr-webhook-timestamp", "nr-webhook-key-id", "nr-webhook-signature"];
+    const headers = new Map();
+    for (const [key, value] of headerPairs) {
+        const name = key.toLowerCase();
+        if (!required.includes(name))
+            continue;
+        if (headers.has(name))
+            throw new Error("Duplicate webhook header");
+        headers.set(name, value);
+    }
+    if (required.some(name => !headers.get(name)))
+        throw new Error("Missing webhook header");
+    const timestamp = headers.get("nr-webhook-timestamp");
+    if (!/^[0-9]{1,12}$/.test(timestamp) || Math.abs(nowSeconds - Number(timestamp)) > 300) {
+        throw new Error("Invalid webhook timestamp");
+    }
+    const keyId = headers.get("nr-webhook-key-id");
+    if (!/^whk_[A-Za-z0-9]{8,64}$/.test(keyId) || !Object.prototype.hasOwnProperty.call(secrets, keyId)) {
+        throw new Error("Unknown webhook key");
+    }
+    const signature = headers.get("nr-webhook-signature");
+    if (!/^v1=[0-9a-f]{64}$/.test(signature))
+        throw new Error("Malformed webhook signature");
+    const expected = createHmac("sha256", secrets[keyId]).update(timestamp).update(".").update(rawBody).digest();
+    if (!timingSafeEqual(expected, Buffer.from(signature.slice(3), "hex")))
+        throw new Error("Invalid webhook signature");
+    let event;
+    try {
+        event = JSON.parse(Buffer.from(rawBody).toString("utf8"));
+    }
+    catch {
+        throw new Error("Invalid webhook JSON");
+    }
+    const { id, type } = envelope(event);
+    if (!isRecord(event) || id !== headers.get("nr-webhook-id")) {
+        throw new Error("Webhook event ID mismatch");
+    }
+    if (typeof type !== "string" || !EVENT_TYPES.has(type)) {
+        throw new Error("Unknown webhook event");
+    }
+    return event;
+}
+/**
+ * The typed assessment carried by a verified assessment.updated event. Throws for
+ * any other event, and for data that is not a full assessment (for example an
+ * expiry notice or a pre-v1 pointer payload).
+ */
+export function webhookAssessment(event) {
+    const { type, data } = envelope(event);
+    if (type !== "assessment.updated")
+        throw new Error("Not an assessment event");
+    if (!isRecord(data) ||
+        typeof data.assessment_id !== "string" ||
+        typeof data.assessment_version !== "number" ||
+        typeof data.status !== "string" ||
+        typeof data.created_at !== "string" ||
+        !Array.isArray(data.incomplete_sources) ||
+        !isRecord(data.timing)) {
+        throw new Error("Webhook data is not a full assessment");
+    }
+    return data;
+}
+export function webhookVerificationResponse(event) {
+    const { type, data } = envelope(event);
+    const challenge = isRecord(data) ? data.challenge : undefined;
+    if (type !== "endpoint.verification" || typeof challenge !== "string" || !/^[A-Za-z0-9_-]{43}$/.test(challenge)) {
+        throw new Error("Invalid endpoint verification event");
+    }
+    return { challenge };
+}

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@noresponse/node",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Server-only NoResponse signup and webhook SDK",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/noresponsehq/noresponse.git",
+    "directory": "sdks/typescript"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "typecheck": "tsc --noEmit",
+    "test": "npm run build && tsc --project tests/tsconfig.json && node --test tests/*.test.mjs"
+  },
+  "devDependencies": {
+    "typescript": "5.9.3",
+    "@types/node": "22.15.30"
+  }
+}