@vobs/captcha 1.1.0 → 1.2.0

package/dist/slider.d.ts

@@ -0,0 +1,160 @@
+import { Signal, VobsNode } from '@vobs/vobs';
+
+type SliderShape = 'puzzle' | 'circle' | 'square' | 'triangle';
+interface SliderCaptchaChallenge {
+    readonly id: string;
+    readonly payload: SliderCaptchaPayload;
+    readonly expiresAt: number;
+}
+interface SliderCaptchaPayload {
+    readonly image?: string;
+    readonly width: number;
+    readonly height: number;
+    readonly startX?: number;
+    readonly targetX: number;
+    readonly targetY: number;
+    readonly rotation?: number;
+    readonly decoys?: readonly SliderCaptchaDecoy[];
+    readonly decoyX?: number;
+    readonly decoyY?: number;
+    readonly decoyRotation?: number;
+    readonly pieceWidth: number;
+    readonly pieceHeight: number;
+    readonly tolerance?: number;
+    readonly shape?: SliderShape;
+}
+interface SliderCaptchaDecoy {
+    readonly x: number;
+    readonly y: number;
+    readonly rotation?: number;
+}
+interface SliderTrailPoint {
+    readonly x: number;
+    readonly y: number;
+    readonly t: number;
+}
+interface SliderTrailAnalysis {
+    readonly pointCount: number;
+    readonly duration: number;
+    readonly distance: number;
+    readonly averageSpeed: number;
+    readonly maxSpeed: number;
+    readonly directionChanges: number;
+    readonly verticalTravel: number;
+    readonly averageInterval: number;
+    readonly looksHuman: boolean;
+}
+interface CaptchaDeviceSignals {
+    readonly sessionId: string;
+    readonly userAgent?: string;
+    readonly platform?: string;
+    readonly language?: string;
+    readonly languages?: readonly string[];
+    readonly timezone?: string;
+    readonly screen?: {
+        readonly width: number;
+        readonly height: number;
+        readonly pixelRatio: number;
+    };
+    readonly viewport?: {
+        readonly width: number;
+        readonly height: number;
+    };
+    readonly touchPoints?: number;
+    readonly hardwareConcurrency?: number;
+    readonly deviceMemory?: number;
+    readonly webdriver?: boolean;
+}
+interface SliderCaptchaResult {
+    readonly x: number;
+    readonly y: number;
+    readonly trail: readonly SliderTrailPoint[];
+    readonly duration: number;
+    readonly analysis: SliderTrailAnalysis;
+    readonly deviceSignals?: CaptchaDeviceSignals;
+}
+interface SliderCaptchaProps {
+    readonly challenge?: SliderCaptchaValue<SliderCaptchaChallenge | null>;
+    readonly status?: SliderCaptchaValue<CaptchaStatus>;
+    readonly disabled?: SliderCaptchaValue<boolean>;
+    readonly collectDeviceSignals?: SliderCaptchaValue<boolean>;
+    readonly onSubmit?: (result: SliderCaptchaResult, challenge: SliderCaptchaChallenge) => void | PromiseLike<unknown>;
+    readonly onRetry?: () => void;
+    readonly onCancel?: () => void;
+    readonly retryLabel?: SliderCaptchaValue<string>;
+    readonly refreshingLabel?: SliderCaptchaValue<string>;
+    readonly retryIcon?: VobsNode | (() => VobsNode | null | undefined);
+    readonly cancelLabel?: SliderCaptchaValue<string>;
+    readonly loadingLabel?: SliderCaptchaValue<string>;
+    readonly emptyLabel?: SliderCaptchaValue<string>;
+    readonly expiredLabel?: SliderCaptchaValue<string>;
+    readonly error?: SliderCaptchaValue<unknown>;
+    readonly errorLabel?: SliderCaptchaValue<string>;
+    readonly label?: SliderCaptchaValue<string>;
+    readonly dragLabel?: SliderCaptchaValue<string>;
+    readonly successDuration?: SliderCaptchaValue<number>;
+    readonly onSuccessDismiss?: () => void;
+    readonly class?: SliderCaptchaValue<string>;
+    readonly className?: SliderCaptchaValue<string>;
+    readonly id?: SliderCaptchaValue<string>;
+    readonly title?: SliderCaptchaValue<string>;
+    readonly role?: SliderCaptchaValue<string>;
+    readonly [name: `aria-${string}`]: string | number | boolean | undefined;
+    readonly [name: `data-${string}`]: string | number | boolean | undefined;
+}
+type SliderCaptchaValue<T> = T | Signal<T> | (() => T);
+declare function collectCaptchaDeviceSignals(): CaptchaDeviceSignals;
+declare function SliderCaptcha(props?: SliderCaptchaProps): VobsNode;
+declare function analyzeSliderTrail(trail: readonly SliderTrailPoint[]): SliderTrailAnalysis;
+
+type CaptchaStatus = 'idle' | 'loading' | 'ready' | 'verifying' | 'verified' | 'expired' | 'error';
+type CaptchaAnswer = string | Readonly<Record<string, unknown>> | null | undefined;
+type CaptchaValue<T> = T | Signal<T> | (() => T);
+interface CaptchaChallenge<T = unknown> {
+    readonly id: string;
+    readonly type?: string;
+    readonly payload?: T;
+    readonly expiresAt: number;
+}
+interface CaptchaSubmitContext<Challenge = unknown> {
+    readonly challenge: CaptchaChallenge<Challenge>;
+    readonly status: CaptchaStatus;
+    readonly disabled: boolean;
+    submit(answer: CaptchaAnswer): void | PromiseLike<unknown>;
+}
+type CaptchaChallengeRenderer<Challenge = unknown> = (context: CaptchaSubmitContext<Challenge>) => VobsNode | null | undefined;
+interface CaptchaProps<Challenge = unknown> {
+    readonly challenge?: CaptchaValue<CaptchaChallenge<Challenge> | null>;
+    readonly status?: CaptchaValue<CaptchaStatus>;
+    readonly error?: CaptchaValue<unknown>;
+    readonly disabled?: CaptchaValue<boolean>;
+    readonly renderChallenge?: CaptchaChallengeRenderer<Challenge>;
+    readonly onSubmit?: (answer: CaptchaAnswer, challenge: CaptchaChallenge<Challenge>) => void | PromiseLike<unknown>;
+    readonly onRetry?: () => void;
+    readonly onCancel?: () => void;
+    readonly retryLabel?: CaptchaValue<string>;
+    readonly cancelLabel?: CaptchaValue<string>;
+    readonly loadingLabel?: CaptchaValue<string>;
+    readonly emptyLabel?: CaptchaValue<string>;
+    readonly expiredLabel?: CaptchaValue<string>;
+    readonly errorLabel?: CaptchaValue<string>;
+    readonly label?: CaptchaValue<string>;
+    readonly messagePlacement?: 'challenge' | 'footer' | 'none';
+    readonly keepChallengeOnError?: boolean;
+    readonly keepChallengeOnLoading?: boolean;
+    readonly keepChallengeOnVerifying?: boolean;
+    readonly showRetry?: boolean;
+    readonly showRetryWhileLoading?: boolean;
+    readonly showCancel?: boolean;
+    readonly retryIcon?: VobsNode | (() => VobsNode | null | undefined);
+    readonly class?: CaptchaValue<string>;
+    readonly className?: CaptchaValue<string>;
+    readonly id?: CaptchaValue<string>;
+    readonly title?: CaptchaValue<string>;
+    readonly role?: CaptchaValue<string>;
+    readonly [name: `aria-${string}`]: string | number | boolean | undefined;
+    readonly [name: `data-${string}`]: string | number | boolean | undefined;
+}
+declare function Captcha<Challenge = unknown>(props?: CaptchaProps<Challenge>): VobsNode;
+
+export { Captcha as C, type CaptchaDeviceSignals, SliderCaptcha, type SliderCaptchaChallenge, type SliderCaptchaDecoy, type SliderCaptchaPayload, type SliderCaptchaProps, type SliderCaptchaResult, type SliderCaptchaValue, type SliderShape, type SliderTrailAnalysis, type SliderTrailPoint, type CaptchaAnswer as a, analyzeSliderTrail, type CaptchaChallenge as b, type CaptchaChallengeRenderer as c, collectCaptchaDeviceSignals, type CaptchaProps as d, type CaptchaStatus as e, type CaptchaSubmitContext as f, type CaptchaValue as g };