@alogram/payrisk 0.1.6

package/dist/_generated/runtime.js

@@ -0,0 +1,338 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.COLLECTION_FORMATS = exports.RequiredError = exports.FetchError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
+exports.querystring = querystring;
+exports.exists = exists;
+exports.mapValues = mapValues;
+exports.canConsumeForm = canConsumeForm;
+exports.BASE_PATH = "https://api-dev.alogram.ai/v1".replace(/\/+$/, "");
+class Configuration {
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null ? this.configuration.basePath : exports.BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+exports.Configuration = Configuration;
+exports.DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+class BaseAPI {
+    constructor(configuration = exports.DefaultConfig) {
+        this.configuration = configuration;
+        this.fetchApi = async (url, init) => {
+            let fetchParams = { url, init };
+            for (const middleware of this.middleware) {
+                if (middleware.pre) {
+                    fetchParams = await middleware.pre({
+                        fetch: this.fetchApi,
+                        ...fetchParams,
+                    }) || fetchParams;
+                }
+            }
+            let response = undefined;
+            try {
+                response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            }
+            catch (e) {
+                for (const middleware of this.middleware) {
+                    if (middleware.onError) {
+                        response = await middleware.onError({
+                            fetch: this.fetchApi,
+                            url: fetchParams.url,
+                            init: fetchParams.init,
+                            error: e,
+                            response: response ? response.clone() : undefined,
+                        }) || response;
+                    }
+                }
+                if (response === undefined) {
+                    if (e instanceof Error) {
+                        throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            for (const middleware of this.middleware) {
+                if (middleware.post) {
+                    response = await middleware.post({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        response: response.clone(),
+                    }) || response;
+                }
+            }
+            return response;
+        };
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+    async request(context, initOverrides) {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+    async createFetchParams(context, initOverrides) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+        const initOverrideFn = typeof initOverrides === "function"
+            ? initOverrides
+            : async () => initOverrides;
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+        const overriddenInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context,
+            }))
+        };
+        let body;
+        if (isFormData(overriddenInit.body)
+            || (overriddenInit.body instanceof URLSearchParams)
+            || isBlob(overriddenInit.body)) {
+            body = overriddenInit.body;
+        }
+        else if (this.isJsonMime(headers['Content-Type'])) {
+            body = JSON.stringify(overriddenInit.body);
+        }
+        else {
+            body = overriddenInit.body;
+        }
+        const init = {
+            ...overriddenInit,
+            body
+        };
+        return { url, init };
+    }
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+exports.BaseAPI = BaseAPI;
+BaseAPI.jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+;
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+class ResponseError extends Error {
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        this.name = "ResponseError";
+    }
+}
+exports.ResponseError = ResponseError;
+class FetchError extends Error {
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        this.name = "FetchError";
+    }
+}
+exports.FetchError = FetchError;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+exports.RequiredError = RequiredError;
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+function mapValues(data, fn) {
+    const result = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+class JSONApiResponse {
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    async value() {
+        return this.transformer(await this.raw.json());
+    }
+}
+exports.JSONApiResponse = JSONApiResponse;
+class VoidApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return undefined;
+    }
+}
+exports.VoidApiResponse = VoidApiResponse;
+class BlobApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.blob();
+    }
+    ;
+}
+exports.BlobApiResponse = BlobApiResponse;
+class TextApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.text();
+    }
+    ;
+}
+exports.TextApiResponse = TextApiResponse;

package/dist/client.d.ts

@@ -0,0 +1,69 @@
+import * as generated from './_generated';
+export interface AlogramClientOptions {
+    baseUrl?: string;
+    apiKey?: string;
+    accessToken?: string;
+    tenantId?: string;
+    clientId?: string;
+    debug?: boolean;
+}
+/**
+ * 🔒 Internal base class for shared SDK logic.
+ */
+declare abstract class AlogramBaseClient {
+    protected options: AlogramClientOptions;
+    protected config: generated.Configuration;
+    protected api: generated.PayriskApi;
+    constructor(options: AlogramClientOptions);
+    protected generateId(prefix: string): string;
+    protected mapError(error: any): Error;
+    protected withTelemetry<T>(name: string, tags: {
+        tid: string;
+        ik: string;
+    }, fn: () => Promise<T>): Promise<T>;
+}
+/**
+ * 🏢 **AlogramRiskClient** (Secret Client)
+ * Designed for server-side environments using a Secret Key (`sk_...`).
+ * Provides full access to risk decisioning and score retrieval.
+ */
+export declare class AlogramRiskClient extends AlogramBaseClient {
+    constructor(options: AlogramClientOptions);
+    /**
+     * 📥 Evaluate risk for a purchase or entity.
+     */
+    checkRisk(request: generated.CheckRequest, overrides?: {
+        idempotencyKey?: string;
+        traceId?: string;
+    }): Promise<generated.DecisionResponse>;
+    /**
+     * 📡 Ingest behavioral signals.
+     */
+    ingestSignals(request: generated.SignalsRequest, overrides?: {
+        idempotencyKey?: string;
+        traceId?: string;
+    }): Promise<void>;
+    /**
+     * 📡 Ingest payment lifecycle events.
+     */
+    ingestEvent(event: generated.PaymentEvent, overrides?: {
+        idempotencyKey?: string;
+        traceId?: string;
+    }): Promise<void>;
+}
+/**
+ * 🌐 **AlogramPublicClient** (Public Client)
+ * Designed for client-side environments (Browsers, Mobile) using a Publishable Key (`pk_...`).
+ * Strictly restricted to non-sensitive ingestion methods.
+ */
+export declare class AlogramPublicClient extends AlogramBaseClient {
+    constructor(options: AlogramClientOptions);
+    /**
+     * 📡 Ingest behavioral signals from the frontend.
+     */
+    ingestSignals(request: generated.SignalsRequest, overrides?: {
+        idempotencyKey?: string;
+        traceId?: string;
+    }): Promise<void>;
+}
+export {};

package/dist/client.js

@@ -0,0 +1,281 @@
+"use strict";
+// Copyright (c) 2025 Alogram Inc.
+// All rights reserved.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlogramPublicClient = exports.AlogramRiskClient = void 0;
+const uuid_1 = require("uuid");
+const async_retry_1 = __importDefault(require("async-retry"));
+const generated = __importStar(require("./_generated"));
+const exceptions_1 = require("./exceptions");
+// --- OpenTelemetry Support (Optional) ---
+let tracer = null;
+try {
+    const { trace } = require('@opentelemetry/api');
+    if (trace) {
+        tracer = trace.getTracer('@alogram/payrisk', '0.1.6');
+    }
+}
+catch (e) {
+    // OTel not available, skip telemetry
+}
+/**
+ * 🔒 Internal base class for shared SDK logic.
+ */
+class AlogramBaseClient {
+    constructor(options) {
+        this.options = options;
+        const baseUrl = options.baseUrl || 'https://api.alogram.ai';
+        const headers = {};
+        if (options.apiKey) {
+            headers['x-api-key'] = options.apiKey;
+        }
+        if (options.accessToken) {
+            headers['Authorization'] = `Bearer ${options.accessToken}`;
+        }
+        if (options.tenantId) {
+            headers['x-trusted-tenant-id'] = options.tenantId;
+        }
+        if (options.clientId) {
+            headers['x-trusted-client-id'] = options.clientId;
+        }
+        this.config = new generated.Configuration({
+            basePath: baseUrl,
+            headers: headers,
+        });
+        this.api = new generated.PayriskApi(this.config);
+    }
+    generateId(prefix) {
+        return `${prefix}_${(0, uuid_1.v4)().replace(/-/g, '')}`;
+    }
+    mapError(error) {
+        if (error instanceof generated.ResponseError) {
+            const status = error.response.status;
+            const message = `API Error: ${error.response.statusText}`;
+            if (status === 401 || status === 403) {
+                return new exceptions_1.AuthenticationError(message, status);
+            }
+            if (status === 429) {
+                return new exceptions_1.RateLimitError(message, status);
+            }
+            if (status === 400 || status === 422) {
+                return new exceptions_1.ValidationError(message, status);
+            }
+            if (status >= 500) {
+                return new exceptions_1.InternalServerError(message, status);
+            }
+            return new exceptions_1.AlogramError(message, status);
+        }
+        // If it's already one of our custom error types, return it directly
+        if (error instanceof exceptions_1.AuthenticationError ||
+            error instanceof exceptions_1.RateLimitError ||
+            error instanceof exceptions_1.ValidationError ||
+            error instanceof exceptions_1.InternalServerError ||
+            error instanceof exceptions_1.AlogramError) {
+            return error;
+        }
+        return error;
+    }
+    async withTelemetry(name, tags, fn) {
+        if (!tracer)
+            return fn();
+        return tracer.startActiveSpan(name, async (span) => {
+            try {
+                span.setAttribute('alogram.trace_id', tags.tid);
+                span.setAttribute('alogram.idempotency_key', tags.ik);
+                const result = await fn();
+                if (typeof result === 'object' && result !== null && 'decision' in result) {
+                    span.setAttribute('alogram.decision', result.decision);
+                }
+                span.setStatus({ code: 1 }); // Ok
+                return result;
+            }
+            catch (err) {
+                span.setStatus({ code: 2, message: err.message }); // Error
+                span.recordException(err);
+                throw err;
+            }
+            finally {
+                span.end();
+            }
+        });
+    }
+}
+/**
+ * 🏢 **AlogramRiskClient** (Secret Client)
+ * Designed for server-side environments using a Secret Key (`sk_...`).
+ * Provides full access to risk decisioning and score retrieval.
+ */
+class AlogramRiskClient extends AlogramBaseClient {
+    constructor(options) {
+        if (options.apiKey && options.apiKey.startsWith('pk_')) {
+            throw new exceptions_1.ScopedAccessError('Cannot initialize AlogramRiskClient with a Publishable Key (pk_...). ' +
+                'Please use AlogramPublicClient for client-side ingestion or provide a Secret Key (sk_...).');
+        }
+        super(options);
+    }
+    /**
+     * 📥 Evaluate risk for a purchase or entity.
+     */
+    async checkRisk(request, overrides) {
+        const ik = overrides?.idempotencyKey || this.generateId('idk');
+        const tid = overrides?.traceId || this.generateId('trc');
+        return this.withTelemetry('alogram.check_risk', { tid, ik }, async () => {
+            const headers = { ...(this.config.headers || {}) };
+            if (request.entities?.tenantId) {
+                headers['x-trusted-tenant-id'] = request.entities.tenantId;
+            }
+            if (request.entities?.clientId) {
+                headers['x-trusted-client-id'] = request.entities.clientId;
+            }
+            try {
+                return await (0, async_retry_1.default)(async (bail) => {
+                    try {
+                        // Re-construct headers for every attempt to ensure consistent state
+                        const attemptHeaders = { ...(this.config.headers || {}) };
+                        if (request.entities?.tenantId) {
+                            attemptHeaders['x-trusted-tenant-id'] = request.entities.tenantId;
+                        }
+                        if (request.entities?.clientId) {
+                            attemptHeaders['x-trusted-client-id'] = request.entities.clientId;
+                        }
+                        return await this.api.riskCheck({
+                            xIdempotencyKey: ik,
+                            xTraceId: tid,
+                            checkRequest: request,
+                        }, { headers: attemptHeaders });
+                    }
+                    catch (err) {
+                        const mapped = this.mapError(err);
+                        if (mapped instanceof exceptions_1.RateLimitError || mapped instanceof exceptions_1.InternalServerError) {
+                            throw mapped; // retry
+                        }
+                        bail(mapped);
+                        throw mapped;
+                    }
+                }, {
+                    retries: 2,
+                    minTimeout: 500,
+                    maxTimeout: 5000,
+                    randomize: true,
+                });
+            }
+            catch (e) {
+                throw this.mapError(e);
+            }
+        });
+    }
+    /**
+     * 📡 Ingest behavioral signals.
+     */
+    async ingestSignals(request, overrides) {
+        const ik = overrides?.idempotencyKey || this.generateId('idk');
+        const tid = overrides?.traceId || this.generateId('trc');
+        return this.withTelemetry('alogram.ingest_signals', { tid, ik }, async () => {
+            const headers = { ...(this.config.headers || {}) };
+            const actualRequest = request.actualInstance || request;
+            if (actualRequest.entities?.tenantId) {
+                headers['x-trusted-tenant-id'] = actualRequest.entities.tenant_id || actualRequest.entities.tenantId;
+            }
+            try {
+                await this.api.ingestSignals({
+                    xIdempotencyKey: ik,
+                    xTraceId: tid,
+                    signalsRequest: request,
+                }, { headers });
+            }
+            catch (err) {
+                throw this.mapError(err);
+            }
+        });
+    }
+    /**
+     * 📡 Ingest payment lifecycle events.
+     */
+    async ingestEvent(event, overrides) {
+        const ik = overrides?.idempotencyKey || this.generateId('idk');
+        const tid = overrides?.traceId || this.generateId('trc');
+        return this.withTelemetry('alogram.ingest_event', { tid, ik }, async () => {
+            try {
+                await this.api.ingestPaymentEvent({
+                    xIdempotencyKey: ik,
+                    xTraceId: tid,
+                    paymentEvent: event,
+                }, { headers: this.config.headers });
+            }
+            catch (err) {
+                throw this.mapError(err);
+            }
+        });
+    }
+}
+exports.AlogramRiskClient = AlogramRiskClient;
+/**
+ * 🌐 **AlogramPublicClient** (Public Client)
+ * Designed for client-side environments (Browsers, Mobile) using a Publishable Key (`pk_...`).
+ * Strictly restricted to non-sensitive ingestion methods.
+ */
+class AlogramPublicClient extends AlogramBaseClient {
+    constructor(options) {
+        if (options.apiKey && options.apiKey.startsWith('sk_')) {
+            throw new exceptions_1.ScopedAccessError('Cannot initialize AlogramPublicClient with a Secret Key (sk_...). ' +
+                'Please use AlogramRiskClient for server-side operations.');
+        }
+        super(options);
+    }
+    /**
+     * 📡 Ingest behavioral signals from the frontend.
+     */
+    async ingestSignals(request, overrides) {
+        const ik = overrides?.idempotencyKey || this.generateId('idk');
+        const tid = overrides?.traceId || this.generateId('trc');
+        return this.withTelemetry('alogram.ingest_signals', { tid, ik }, async () => {
+            try {
+                await this.api.ingestSignals({
+                    xIdempotencyKey: ik,
+                    xTraceId: tid,
+                    signalsRequest: request,
+                }, { headers: this.config.headers });
+            }
+            catch (err) {
+                throw this.mapError(err);
+            }
+        });
+    }
+}
+exports.AlogramPublicClient = AlogramPublicClient;