@truesift/express 0.1.0

package/dist/index-DWCqfBfQ.d.ts

@@ -0,0 +1,135 @@
+type TrueSiftErrorCode = 'TRUESIFT_CONFIG_ERROR' | 'TRUESIFT_REQUEST_ERROR' | 'TRUESIFT_TIMEOUT_ERROR' | 'TRUESIFT_AUTH_ERROR' | 'TRUESIFT_RESPONSE_ERROR' | 'TRUESIFT_API_ERROR';
+interface TrueSiftErrorContext {
+    readonly [key: string]: unknown;
+}
+interface TrueSiftErrorOptions {
+    readonly code: TrueSiftErrorCode;
+    readonly message: string;
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+interface TrueSiftApiErrorPayload {
+    readonly code?: string | undefined;
+    readonly message?: string | undefined;
+    readonly details?: unknown;
+}
+interface TrueSiftApiErrorContext extends TrueSiftErrorContext {
+    readonly apiError?: TrueSiftApiErrorPayload | undefined;
+}
+interface TrueSiftHttpErrorContext extends TrueSiftErrorContext {
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly endpoint?: string | undefined;
+    readonly method?: string | undefined;
+}
+type BotGuardErrorCode = TrueSiftErrorCode;
+type BotGuardErrorContext = TrueSiftErrorContext;
+type BotGuardErrorOptions = TrueSiftErrorOptions;
+type BotGuardApiErrorPayload = TrueSiftApiErrorPayload;
+type BotGuardApiErrorContext = TrueSiftApiErrorContext;
+type BotGuardHttpErrorContext = TrueSiftHttpErrorContext;
+
+declare class BotGuardError extends Error {
+    readonly code: TrueSiftErrorCode;
+    readonly statusCode?: number;
+    readonly requestId?: string;
+    readonly context?: TrueSiftErrorContext;
+    constructor(options: TrueSiftErrorOptions);
+    toJSON(): {
+        readonly name: string;
+        readonly code: TrueSiftErrorCode;
+        readonly message: string;
+        readonly statusCode?: number;
+        readonly requestId?: string;
+        readonly context?: TrueSiftErrorContext;
+    };
+}
+
+interface BotGuardConfigErrorOptions {
+    readonly message?: string | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+declare class BotGuardConfigError extends BotGuardError {
+    constructor(options?: BotGuardConfigErrorOptions);
+}
+
+interface BotGuardRequestErrorOptions {
+    readonly message?: string | undefined;
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+declare class BotGuardRequestError extends BotGuardError {
+    constructor(options?: BotGuardRequestErrorOptions);
+}
+
+interface BotGuardTimeoutErrorOptions {
+    readonly message?: string | undefined;
+    readonly timeoutMs?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+declare class BotGuardTimeoutError extends BotGuardError {
+    readonly timeoutMs?: number;
+    constructor(options?: BotGuardTimeoutErrorOptions);
+    toJSON(): {
+        readonly name: string;
+        readonly code: 'TRUESIFT_TIMEOUT_ERROR';
+        readonly message: string;
+        readonly statusCode?: number;
+        readonly requestId?: string;
+        readonly context?: TrueSiftErrorContext;
+        readonly timeoutMs?: number;
+    };
+}
+
+interface BotGuardAuthErrorOptions {
+    readonly message?: string | undefined;
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+declare class BotGuardAuthError extends BotGuardError {
+    constructor(options?: BotGuardAuthErrorOptions);
+}
+
+interface BotGuardResponseErrorOptions {
+    readonly message?: string | undefined;
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+declare class BotGuardResponseError extends BotGuardError {
+    constructor(options?: BotGuardResponseErrorOptions);
+}
+
+interface BotGuardApiErrorOptions {
+    readonly message?: string | undefined;
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+    readonly apiError?: TrueSiftApiErrorPayload | undefined;
+    readonly context?: TrueSiftErrorContext | undefined;
+    readonly cause?: unknown;
+}
+declare class BotGuardApiError extends BotGuardError {
+    readonly apiError?: TrueSiftApiErrorPayload;
+    constructor(options?: BotGuardApiErrorOptions);
+    toJSON(): {
+        readonly name: string;
+        readonly code: 'TRUESIFT_API_ERROR';
+        readonly message: string;
+        readonly statusCode?: number;
+        readonly requestId?: string;
+        readonly context?: TrueSiftErrorContext;
+        readonly apiError?: TrueSiftApiErrorPayload;
+    };
+}
+
+export { BotGuardApiError as B, type TrueSiftApiErrorContext as T, type BotGuardApiErrorContext as a, type BotGuardApiErrorPayload as b, BotGuardAuthError as c, BotGuardConfigError as d, BotGuardError as e, type BotGuardErrorCode as f, type BotGuardErrorContext as g, type BotGuardErrorOptions as h, type BotGuardHttpErrorContext as i, BotGuardRequestError as j, BotGuardResponseError as k, BotGuardTimeoutError as l, type TrueSiftApiErrorPayload as m, type TrueSiftErrorCode as n, type TrueSiftErrorContext as o, type TrueSiftErrorOptions as p, type TrueSiftHttpErrorContext as q };

package/dist/index.d.ts

@@ -0,0 +1,280 @@
+export { B as BotGuardApiError, a as BotGuardApiErrorContext, b as BotGuardApiErrorPayload, c as BotGuardAuthError, d as BotGuardConfigError, e as BotGuardError, f as BotGuardErrorCode, g as BotGuardErrorContext, h as BotGuardErrorOptions, i as BotGuardHttpErrorContext, j as BotGuardRequestError, k as BotGuardResponseError, l as BotGuardTimeoutError, B as TrueSiftApiError, T as TrueSiftApiErrorContext, m as TrueSiftApiErrorPayload, c as TrueSiftAuthError, d as TrueSiftConfigError, e as TrueSiftError, n as TrueSiftErrorCode, o as TrueSiftErrorContext, p as TrueSiftErrorOptions, q as TrueSiftHttpErrorContext, j as TrueSiftRequestError, k as TrueSiftResponseError, l as TrueSiftTimeoutError } from './index-DWCqfBfQ.js';
+
+interface TrueSiftLoggerContext {
+    readonly [key: string]: unknown;
+}
+interface TrueSiftLogger {
+    readonly warn?: (message: string, context?: TrueSiftLoggerContext) => void;
+    readonly error?: (message: string, context?: TrueSiftLoggerContext) => void;
+}
+type TrueSiftFetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+interface TrueSiftClientConfig {
+    readonly apiBaseUrl: string | undefined;
+    readonly siteKey: string | undefined;
+    readonly secretKey: string | undefined;
+    readonly defaultAction?: string | undefined;
+    readonly defaultOrigin?: string | undefined;
+    readonly timeoutMs?: number | undefined;
+    readonly fetchImpl?: TrueSiftFetch | undefined;
+    readonly logger?: TrueSiftLogger | undefined;
+}
+interface NormalizedTrueSiftClientConfig {
+    readonly apiBaseUrl: string;
+    readonly siteKey: string;
+    readonly secretKey: string;
+    readonly defaultAction?: string;
+    readonly defaultOrigin?: string;
+    readonly timeoutMs: number;
+    readonly fetchImpl: TrueSiftFetch;
+    readonly logger?: TrueSiftLogger;
+}
+interface TrueSiftSafeClientConfig {
+    readonly apiBaseUrl?: string;
+    readonly siteKey?: string;
+    readonly defaultAction?: string;
+    readonly defaultOrigin?: string;
+    readonly timeoutMs?: number;
+    readonly hasSecretKey: boolean;
+    readonly hasCustomFetch: boolean;
+    readonly hasLogger: boolean;
+}
+type BotGuardLoggerContext = TrueSiftLoggerContext;
+type BotGuardLogger = TrueSiftLogger;
+type BotGuardFetch = TrueSiftFetch;
+type BotGuardClientConfig = TrueSiftClientConfig;
+type NormalizedBotGuardClientConfig = NormalizedTrueSiftClientConfig;
+type BotGuardSafeClientConfig = TrueSiftSafeClientConfig;
+
+type TrueSiftChallengeMetadata = Readonly<Record<string, unknown>>;
+interface TrueSiftCreateChallengeInput {
+    readonly siteKey?: string | undefined;
+    readonly origin?: string | undefined;
+    readonly action?: string | undefined;
+    readonly path?: string | undefined;
+    readonly metadata?: TrueSiftChallengeMetadata | undefined;
+}
+interface TrueSiftCreateChallengePayload {
+    readonly siteKey: string;
+    readonly origin: string;
+    readonly action: string;
+    readonly path: string;
+    readonly metadata?: TrueSiftChallengeMetadata | undefined;
+}
+interface TrueSiftChallengeResult {
+    readonly success: true;
+    readonly challengeId: string;
+    readonly challengeToken: string;
+    readonly expiresAt: string;
+    readonly requestId?: string | undefined;
+    readonly raw?: unknown;
+}
+interface TrueSiftChallengeApiResponse {
+    readonly success: true;
+    readonly challengeId: string;
+    readonly challengeToken: string;
+    readonly expiresAt: string;
+    readonly requestId?: string | undefined;
+}
+interface TrueSiftChallengeValidationContext {
+    readonly siteKey?: string | undefined;
+    readonly origin?: string | undefined;
+    readonly action?: string | undefined;
+    readonly path?: string | undefined;
+}
+type BotGuardChallengeMetadata = TrueSiftChallengeMetadata;
+type BotGuardCreateChallengeInput = TrueSiftCreateChallengeInput;
+type BotGuardCreateChallengePayload = TrueSiftCreateChallengePayload;
+type BotGuardChallengeResult = TrueSiftChallengeResult;
+type BotGuardChallengeApiResponse = TrueSiftChallengeApiResponse;
+type BotGuardChallengeValidationContext = TrueSiftChallengeValidationContext;
+
+declare const TRUE_SIFT_DECISIONS: readonly ["allow", "review", "block"];
+type TrueSiftDecision = (typeof TRUE_SIFT_DECISIONS)[number];
+type BotGuardDecision = TrueSiftDecision;
+declare const TRUE_SIFT_VERIFICATION_MODES: readonly ["observe", "protect"];
+type TrueSiftVerificationMode = (typeof TRUE_SIFT_VERIFICATION_MODES)[number];
+type BotGuardVerificationMode = TrueSiftVerificationMode;
+interface TrueSiftDecisionMetadata {
+    readonly mode?: TrueSiftVerificationMode;
+    readonly calculatedDecision?: TrueSiftDecision;
+    readonly effectiveDecision?: TrueSiftDecision;
+}
+type BotGuardDecisionMetadata = TrueSiftDecisionMetadata;
+interface TrueSiftDecisionFlags {
+    readonly isAllowed: boolean;
+    readonly isReview: boolean;
+    readonly isBlocked: boolean;
+}
+type BotGuardDecisionFlags = TrueSiftDecisionFlags;
+
+type TrueSiftVerifyMetadata = Readonly<Record<string, unknown>>;
+interface TrueSiftClientSignals {
+    readonly elapsedMs?: number | undefined;
+    readonly honeypotValue?: string | undefined;
+}
+interface TrueSiftVerifyChallengeInput {
+    readonly siteKey?: string | undefined;
+    readonly secretKey?: string | undefined;
+    readonly challengeId?: string | undefined;
+    readonly challengeToken?: string | undefined;
+    readonly origin?: string | undefined;
+    readonly action?: string | undefined;
+    readonly path?: string | undefined;
+    readonly clientSignals?: TrueSiftClientSignals | undefined;
+    readonly metadata?: TrueSiftVerifyMetadata | undefined;
+}
+interface TrueSiftVerifyChallengePayload {
+    readonly siteKey: string;
+    readonly secretKey: string;
+    readonly challengeId: string;
+    readonly challengeToken: string;
+    readonly origin: string;
+    readonly action: string;
+    readonly path: string;
+    readonly clientSignals?: TrueSiftClientSignals | undefined;
+    readonly metadata?: TrueSiftVerifyMetadata | undefined;
+}
+interface TrueSiftVerifyResult extends TrueSiftDecisionMetadata {
+    readonly success: true;
+    readonly decision: TrueSiftDecision;
+    readonly score: number;
+    readonly reasonCodes: readonly string[];
+    readonly challengeId?: string | undefined;
+    readonly requestId?: string | undefined;
+    readonly isAllowed: boolean;
+    readonly isReview: boolean;
+    readonly isBlocked: boolean;
+    readonly raw?: unknown;
+}
+interface TrueSiftVerifyApiResponse {
+    readonly success: true;
+    readonly decision: string;
+    readonly score: number;
+    readonly reasonCodes?: readonly string[] | undefined;
+    readonly challengeId?: string | undefined;
+    readonly requestId?: string | undefined;
+    readonly mode?: string | undefined;
+    readonly calculatedDecision?: string | undefined;
+    readonly effectiveDecision?: string | undefined;
+}
+interface TrueSiftVerifyValidationContext {
+    readonly siteKey?: string | undefined;
+    readonly secretKey?: string | undefined;
+    readonly challengeId?: string | undefined;
+    readonly challengeToken?: string | undefined;
+    readonly origin?: string | undefined;
+    readonly action?: string | undefined;
+    readonly path?: string | undefined;
+}
+type BotGuardVerifyMetadata = TrueSiftVerifyMetadata;
+type BotGuardClientSignals = TrueSiftClientSignals;
+type BotGuardVerifyChallengeInput = TrueSiftVerifyChallengeInput;
+type BotGuardVerifyChallengePayload = TrueSiftVerifyChallengePayload;
+interface BotGuardVerifyResult extends BotGuardDecisionMetadata {
+    readonly success: true;
+    readonly decision: BotGuardDecision;
+    readonly score: number;
+    readonly reasonCodes: readonly string[];
+    readonly challengeId?: string | undefined;
+    readonly requestId?: string | undefined;
+    readonly isAllowed: boolean;
+    readonly isReview: boolean;
+    readonly isBlocked: boolean;
+    readonly raw?: unknown;
+}
+type BotGuardVerifyApiResponse = TrueSiftVerifyApiResponse;
+type BotGuardVerifyValidationContext = TrueSiftVerifyValidationContext;
+
+declare class BotGuardClient {
+    readonly config: NormalizedBotGuardClientConfig;
+    constructor(config: NormalizedBotGuardClientConfig);
+    createChallenge(input?: BotGuardCreateChallengeInput): Promise<BotGuardChallengeResult>;
+    verifyChallenge(input: BotGuardVerifyChallengeInput): Promise<BotGuardVerifyResult>;
+}
+declare class TrueSiftClient extends BotGuardClient {
+    constructor(config: NormalizedTrueSiftClientConfig);
+    createChallenge(input?: TrueSiftCreateChallengeInput): Promise<TrueSiftChallengeResult>;
+    verifyChallenge(input: TrueSiftVerifyChallengeInput): Promise<TrueSiftVerifyResult>;
+}
+
+declare function createBotGuardClient(config: BotGuardClientConfig): BotGuardClient;
+declare function createTrueSiftClient(config: TrueSiftClientConfig): TrueSiftClient;
+
+interface DecisionLike {
+    readonly decision?: TrueSiftDecision;
+}
+interface BotGuardDecisionLike {
+    readonly decision?: BotGuardDecision;
+}
+declare function isAllowedDecision(decision: TrueSiftDecision): boolean;
+declare function isReviewDecision(decision: TrueSiftDecision): boolean;
+declare function isBlockedDecision(decision: TrueSiftDecision): boolean;
+declare function createDecisionFlags(decision: TrueSiftDecision): TrueSiftDecisionFlags;
+declare function isAllowed(result: DecisionLike): boolean;
+declare function isReview(result: DecisionLike): boolean;
+declare function isBlocked(result: DecisionLike): boolean;
+declare const isBotGuardAllowedDecision: typeof isAllowedDecision;
+declare const isBotGuardReviewDecision: typeof isReviewDecision;
+declare const isBotGuardBlockedDecision: typeof isBlockedDecision;
+declare function createBotGuardDecisionFlags(decision: BotGuardDecision): TrueSiftDecisionFlags;
+declare function isBotGuardAllowed(result: BotGuardDecisionLike): boolean;
+declare function isBotGuardReview(result: BotGuardDecisionLike): boolean;
+declare function isBotGuardBlocked(result: BotGuardDecisionLike): boolean;
+
+declare function isTrueSiftDecision(value: unknown): value is TrueSiftDecision;
+declare const isBotGuardDecision: typeof isTrueSiftDecision;
+declare function normalizeDecision(value: unknown): TrueSiftDecision;
+declare function normalizeBotGuardDecision(value: unknown): BotGuardDecision;
+
+declare const REDACTED_VALUE = "[REDACTED]";
+declare function redactSensitiveValue(value: unknown): unknown;
+declare function isSensitiveKey(key: string): boolean;
+declare function redactSensitiveRecord(record: Readonly<Record<string, unknown>>): Record<string, unknown>;
+declare function redactTrueSiftClientConfig(config: TrueSiftClientConfig): TrueSiftSafeClientConfig;
+declare function redactBotGuardConfig(config: BotGuardClientConfig): BotGuardSafeClientConfig;
+
+type TrueSiftHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+interface TrueSiftRequestOptions {
+    readonly method: TrueSiftHttpMethod;
+    readonly endpoint: string;
+    readonly body?: unknown;
+    readonly timeoutMs: number;
+    readonly signal?: AbortSignal | undefined;
+}
+interface TrueSiftHttpResponse<TBody = unknown> {
+    readonly statusCode: number;
+    readonly ok: boolean;
+    readonly headers: Headers;
+    readonly body: TBody;
+    readonly requestId?: string | undefined;
+}
+interface TrueSiftRequestContext {
+    readonly method: TrueSiftHttpMethod;
+    readonly endpoint: string;
+    readonly timeoutMs?: number | undefined;
+    readonly statusCode?: number | undefined;
+    readonly requestId?: string | undefined;
+}
+interface TrueSiftJsonErrorResponse {
+    readonly success: false;
+    readonly error?: {
+        readonly code?: string;
+        readonly message?: string;
+        readonly details?: unknown;
+    };
+    readonly requestId?: string;
+}
+interface TrueSiftJsonSuccessResponse {
+    readonly success: true;
+    readonly requestId?: string;
+}
+type TrueSiftJsonResponse = TrueSiftJsonSuccessResponse | TrueSiftJsonErrorResponse;
+type BotGuardHttpMethod = TrueSiftHttpMethod;
+type BotGuardRequestOptions = TrueSiftRequestOptions;
+type BotGuardHttpResponse<TBody = unknown> = TrueSiftHttpResponse<TBody>;
+type BotGuardRequestContext = TrueSiftRequestContext;
+type BotGuardJsonErrorResponse = TrueSiftJsonErrorResponse;
+type BotGuardJsonSuccessResponse = TrueSiftJsonSuccessResponse;
+type BotGuardJsonResponse = TrueSiftJsonResponse;
+
+export { type BotGuardChallengeApiResponse, type BotGuardChallengeMetadata, type BotGuardChallengeResult, type BotGuardChallengeValidationContext, BotGuardClient, type BotGuardClientConfig, type BotGuardClientSignals, type BotGuardCreateChallengeInput, type BotGuardCreateChallengePayload, type BotGuardDecision, type BotGuardDecisionFlags, type BotGuardDecisionMetadata, type BotGuardFetch, type BotGuardHttpMethod, type BotGuardHttpResponse, type BotGuardJsonErrorResponse, type BotGuardJsonResponse, type BotGuardJsonSuccessResponse, type BotGuardLogger, type BotGuardLoggerContext, type BotGuardRequestContext, type BotGuardRequestOptions, type BotGuardSafeClientConfig, type BotGuardVerificationMode, type BotGuardVerifyApiResponse, type BotGuardVerifyChallengeInput, type BotGuardVerifyChallengePayload, type BotGuardVerifyMetadata, type BotGuardVerifyResult, type BotGuardVerifyValidationContext, type NormalizedBotGuardClientConfig, type NormalizedTrueSiftClientConfig, REDACTED_VALUE, type TrueSiftChallengeApiResponse, type TrueSiftChallengeMetadata, type TrueSiftChallengeResult, type TrueSiftChallengeValidationContext, TrueSiftClient, type TrueSiftClientConfig, type TrueSiftClientSignals, type TrueSiftCreateChallengeInput, type TrueSiftCreateChallengePayload, type TrueSiftDecision, type TrueSiftDecisionFlags, type TrueSiftDecisionMetadata, type TrueSiftFetch, type TrueSiftHttpMethod, type TrueSiftHttpResponse, type TrueSiftJsonErrorResponse, type TrueSiftJsonResponse, type TrueSiftJsonSuccessResponse, type TrueSiftLogger, type TrueSiftLoggerContext, type TrueSiftRequestContext, type TrueSiftRequestOptions, type TrueSiftSafeClientConfig, type TrueSiftVerificationMode, type TrueSiftVerifyApiResponse, type TrueSiftVerifyChallengeInput, type TrueSiftVerifyChallengePayload, type TrueSiftVerifyMetadata, type TrueSiftVerifyResult, type TrueSiftVerifyValidationContext, createBotGuardClient, createBotGuardDecisionFlags, createDecisionFlags, createTrueSiftClient, isAllowed, isAllowedDecision, isBlocked, isBlockedDecision, isBotGuardAllowed, isBotGuardAllowedDecision, isBotGuardBlocked, isBotGuardBlockedDecision, isBotGuardDecision, isBotGuardReview, isBotGuardReviewDecision, isReview, isReviewDecision, isSensitiveKey, isTrueSiftDecision, normalizeBotGuardDecision, normalizeDecision, redactBotGuardConfig, redactSensitiveRecord, redactSensitiveValue, redactTrueSiftClientConfig };