@alogram/payrisk 0.1.6

package/AI.md

@@ -0,0 +1,37 @@
+# Alogram PayRisk SDK for TypeScript & JavaScript — AI Integration Guide
+
+> [!IMPORTANT]
+> This file is optimized for Large Language Models (LLMs) and AI Agents. It provides a dense mental model and implementation rules to ensure a 100% correct integration.
+
+## 🧠 Mental Model
+Alogram PayRisk uses a **"Dual-Trust" Smart Client** architecture.
+1. **`AlogramRiskClient`**: For server-side backend logic. High trust. Requires `sk_...` keys.
+2. **`AlogramPublicClient`**: For frontend/public signals. Low trust. Requires `pk_...` keys.
+
+## 🛠️ Core Workflows
+
+### 1. Synchronous Purchase Risk Check
+**Objective**: Determine if a purchase should be approved, declined, or stepped up.
+**Method**: `AlogramRiskClient.checkRisk(request: CheckRequest)`
+**Critical Parameters**: 
+- `idempotency_key`: Must be unique per transaction (e.g., `idk_{tx_id}`).
+- `trace_id`: Optional but recommended for end-to-end debugging.
+
+### 2. Behavioral Signal Ingestion
+**Objective**: Collect non-payment events (login, signup) to train the model.
+**Method**: `AlogramPublicClient.ingestSignals(request: SignalsRequest)`
+
+## 🛡️ Error Handling Rules
+AI Agents must implement the following logic:
+- **`RateLimitError`**: Implement exponential backoff (Handled by SDK, but don't overwhelm).
+- **`ValidationError`**: Terminal. Log the `e.body` and do not retry.
+- **`ScopedAccessError`**: Occurs if a `pk_` key is used in `AlogramRiskClient`. Instruct the user to check their key prefix.
+
+## 🧩 Common hallucination prevention
+- **Field Naming**: Always use `assessmentId` (not `requestId`) when referencing decisions.
+- **Decision Values**: Decisions are strictly lowercase: `approve`, `decline`, `review`, `step_up`.
+- **Amounts**: Always pass `amount` as a float.
+
+## 🧪 Testing
+- **Local Mocking**: Use `require('@alogram/payrisk/testing').MockRiskClient` for unit tests.
+- **Integration**: Point `base_url` to `http://localhost:8080` if using the Alogram Local Emulator.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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, publically 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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,129 @@
+# Alogram PayRisk SDK for TypeScript & JavaScript
+
+[![NPM version](https://img.shields.io/npm/v/@alogram/payrisk.svg)](https://www.npmjs.com/package/@alogram/payrisk)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+The official Alogram PayRisk 'Smart' SDK for TypeScript and Node.js. Designed for high-performance financial systems that require resilient risk intelligence and native observability.
+
+## 🚀 Features
+
+-   **🏢 Smart Client Architecture**: Dedicated clients for server-side (`AlogramRiskClient`) and browser (`AlogramPublicClient`).
+-   **🛡️ Automated Identity**: Automatic injection of `x-api-key`, `Authorization`, and tenant headers.
+-   **🔄 Built-in Resiliency**: Transparent exponential backoff and jittered retries (3 retries on 429/5xx).
+-   **🕵️ OpenTelemetry Native**: Built-in tracing for monitoring risk decision latency and outcomes.
+-   **📐 Type Safety**: Deeply typed models for all request/response payloads.
+
+## 📦 Installation
+
+```bash
+npm install @alogram/payrisk
+```
+
+## 🛠️ Quick Start
+
+### Evaluate Risk (Server-Side)
+
+```typescript
+import { AlogramRiskClient } from '@alogram/payrisk';
+
+const client = new AlogramRiskClient({
+  apiKey: 'sk_live_your_secret_key',
+  tenantId: 'tenant_123'
+});
+
+async function runCheck() {
+  const decision = await client.checkRisk({
+    purchase: { amount: 99.99, currency: 'USD' },
+    identity: { email: 'customer@example.com' }
+  });
+  console.log(`Decision: ${decision.decision}`);
+}
+```
+
+---
+
+## 🛡️ Error Handling
+
+Catch specific errors to manage your checkout flow gracefully:
+
+```typescript
+import { RateLimitError, ValidationError, AlogramError } from '@alogram/payrisk';
+
+try {
+  const decision = await client.checkRisk(request);
+} catch (error) {
+  if (error instanceof RateLimitError) {
+    // 🔄 SDK handles retries, but you can add custom logging here
+  } else if (error instanceof ValidationError) {
+    // ❌ Handle invalid input data
+    console.error(error.message);
+  } else if (error instanceof AlogramError) {
+    // 🚨 Generic API error
+  }
+}
+```
+
+## 🔑 Authentication & Keys
+
+Obtain your keys from the [Alogram Dashboard](https://dashboard.alogram.ai/keys).
+
+| Key Type | Prefix | Client | Use Case |
+| :--- | :--- | :--- | :--- |
+| **Secret Key** | `sk_live_...` | `AlogramRiskClient` | Server-side risk checks. **Never expose.** |
+| **Publishable Key** | `pk_live_...` | `AlogramPublicClient` | Frontend behavioral signals. |
+
+## 🤖 For AI Agents (Integration Context)
+
+If you are using an AI agent (like ChatGPT, Claude, or Gemini), provide this context:
+
+> "I am integrating the Alogram PayRisk TypeScript SDK. I need to call `checkRisk` in my backend service. Use the `AlogramRiskClient`, handle `RateLimitError` gracefully, and ensure you use the `idempotencyKey` parameter."
+
+---
+
+## 🧪 Local Testing & Mocking
+
+Use the zero-dependency `MockRiskClient` for your test suite:
+
+```typescript
+import { MockRiskClient } from '@alogram/payrisk/testing';
+
+const mock = new MockRiskClient();
+mock.queueDecision('decline', 0.99, 'high_risk_ip');
+
+const decision = await myApp.process(mock);
+console.log(decision.decision); // 'decline'
+```
+
+## 🏗️ Environment Testing
+
+### Alogram Sandbox
+For safe integration testing, point your client to the Sandbox environment:
+```typescript
+const client = new AlogramRiskClient({
+  apiKey: 'sk_test_...',
+  baseUrl: 'https://api-sandbox.alogram.ai'
+});
+```
+
+### Local Emulator
+For hermetic local testing, run the **Alogram Local Emulator**:
+```bash
+docker run -p 8080:8080 alogram/payrisk-emulator
+```
+Point your client to the local instance:
+```typescript
+const client = new AlogramRiskClient({
+  baseUrl: 'http://localhost:8080',
+  apiKey: 'test'
+});
+```
+
+---
+
+## 📚 Documentation
+
+For full API reference, visit [docs.alogram.ai](https://docs.alogram.ai).
+
+## ⚖️ License
+
+Apache License 2.0. See [LICENSE](LICENSE) for details.

package/dist/_generated/apis/PayriskApi.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Payments Risk API
+ * API for detecting and scoring fraud for purchases, with lifecycle labeling and behavioral signals. v1 focuses on purchases only (`/risk/check`), with future account/session and KYC checks stubbed below.
+ *
+ * The version of the OpenAPI document: 0.1.6-rc.3
+ * Contact: support@alogram.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AccountCheckRequest, CheckRequest, DecisionResponse, KycCheckRequest, PaymentEvent, ScoresSuccessResponse, SignalsRequest } from '../models/index';
+export interface AccountRiskCheckRequest {
+    xIdempotencyKey: string;
+    accountCheckRequest: AccountCheckRequest;
+    xTraceId?: string;
+}
+export interface GetFraudScoresRequest {
+    tenantId: string;
+    xTraceId?: string;
+    xIdempotencyKey?: string;
+    startTime?: string;
+    endTime?: string;
+    pageSize?: number;
+    pageToken?: string;
+}
+export interface IngestPaymentEventRequest {
+    xIdempotencyKey: string;
+    paymentEvent: PaymentEvent;
+    xTraceId?: string;
+}
+export interface IngestSignalsRequest {
+    xIdempotencyKey: string;
+    signalsRequest: SignalsRequest;
+    xTraceId?: string;
+}
+export interface KycRiskCheckRequest {
+    xIdempotencyKey: string;
+    kycCheckRequest: KycCheckRequest;
+    xTraceId?: string;
+}
+export interface RiskCheckRequest {
+    xIdempotencyKey: string;
+    checkRequest: CheckRequest;
+    xTraceId?: string;
+}
+/**
+ *
+ */
+export declare class PayriskApi extends runtime.BaseAPI {
+    /**
+     * Synchronous fraud decision for account/session events (signup, login, settings)
+     */
+    accountRiskCheckRaw(requestParameters: AccountRiskCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DecisionResponse>>;
+    /**
+     * Synchronous fraud decision for account/session events (signup, login, settings)
+     */
+    accountRiskCheck(requestParameters: AccountRiskCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DecisionResponse>;
+    /**
+     * Retrieve fraud scores for a customer
+     */
+    getFraudScoresRaw(requestParameters: GetFraudScoresRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScoresSuccessResponse>>;
+    /**
+     * Retrieve fraud scores for a customer
+     */
+    getFraudScores(requestParameters: GetFraudScoresRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScoresSuccessResponse>;
+    /**
+     * Health check for the service
+     */
+    healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Health check for the service
+     */
+    healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Ingest payment lifecycle events (authorization, capture, settlement, refund, dispute, chargeback, chargeback_outcome).
+     */
+    ingestPaymentEventRaw(requestParameters: IngestPaymentEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Ingest payment lifecycle events (authorization, capture, settlement, refund, dispute, chargeback, chargeback_outcome).
+     */
+    ingestPaymentEvent(requestParameters: IngestPaymentEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Ingest non-payment signals (account or interaction) for modeling
+     */
+    ingestSignalsRaw(requestParameters: IngestSignalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Ingest non-payment signals (account or interaction) for modeling
+     */
+    ingestSignals(requestParameters: IngestSignalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Synchronous decision for KYC/identity verification
+     */
+    kycRiskCheckRaw(requestParameters: KycRiskCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DecisionResponse>>;
+    /**
+     * Synchronous decision for KYC/identity verification
+     */
+    kycRiskCheck(requestParameters: KycRiskCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DecisionResponse>;
+    /**
+     * Synchronous fraud decision for a purchase
+     */
+    riskCheckRaw(requestParameters: RiskCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DecisionResponse>>;
+    /**
+     * Synchronous fraud decision for a purchase
+     */
+    riskCheck(requestParameters: RiskCheckRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DecisionResponse>;
+}