Fix/invisible mode on session record

.changeset/quiet-rabbits-joke.md

@@ -0,0 +1,10 @@
+---
+"@prosopo/procaptcha-frictionless": patch
+"@prosopo/types-database": patch
+"@prosopo/provider": patch
+"@prosopo/types": patch
+"@prosopo/api": patch
+---
+
+Adding invisible mode to session data
+

packages/api/src/api/ProviderApi.ts

@@ -26,11 +26,13 @@ import {
 	type DecisionMachineLanguage,
 	type DecisionMachineRuntime,
 	type DecisionMachineScope,
+	type GetFrictionlessCaptchaChallengeRequestBodyOutput,
 	type GetFrictionlessCaptchaResponse,
 	type GetPowCaptchaChallengeRequestBodyType,
 	type GetPowCaptchaResponse,
 	type IUserSettings,
 	type ImageVerificationResponse,
+	type ModeEnum,
 	type PowCaptchaSolutionResponse,
 	type ProcaptchaToken,
 	type Provider,
@@ -207,12 +209,14 @@ export default class ProviderApi
 		headHash: string,
 		dapp: string,
 		user: string,
+		mode?: ModeEnum,
 	): Promise<GetFrictionlessCaptchaResponse> {
-		const body = {
+		const body: GetFrictionlessCaptchaChallengeRequestBodyOutput = {
 			[ApiParams.token]: token,
 			[ApiParams.headHash]: headHash,
 			[ApiParams.dapp]: dapp,
 			[ApiParams.user]: user,
+			...(mode && { [ApiParams.mode]: mode }),
 		};
 		return this.post(ClientApiPaths.GetFrictionlessCaptchaChallenge, body, {
 			headers: {

packages/procaptcha-frictionless/src/customDetectBot.ts

@@ -98,6 +98,7 @@ const customDetectBot: BotDetectionFunction = async (
 			detectionResult.encryptHeadHash,
 			config.account.address,
 			userAccount.account.address,
+			config.mode,
 		),
 		10000, // 10 second timeout
 	);

packages/provider/src/api/captcha/getFrictionlessCaptchaChallenge.ts

@@ -17,6 +17,7 @@ import {
 	CaptchaType,
 	ContextType,
 	GetFrictionlessCaptchaChallengeRequestBody,
+	ModeEnum,
 } from "@prosopo/types";
 import type { ScoreComponents } from "@prosopo/types";
 import type { ProviderEnvironment } from "@prosopo/types-env";
@@ -76,9 +77,11 @@ export default (
 			});
 
 			const tasks = new Tasks(env, req.logger);
-			const { token, headHash, dapp, user } =
+			const { token, headHash, dapp, user, mode } =
 				GetFrictionlessCaptchaChallengeRequestBody.parse(req.body);
 			const normalizedIp = normalizeRequestIp(req.ip, req.logger);
+			const sessionMode =
+				mode === ModeEnum.invisible ? ModeEnum.invisible : undefined;
 
 			req.logger.info(() => ({
 				msg: "Frictionless handler entry",
@@ -91,6 +94,7 @@ export default (
 					ja4: req.ja4,
 					path: req.path,
 					method: req.method,
+					...(sessionMode && { mode: sessionMode }),
 				},
 			}));
 
@@ -116,6 +120,7 @@ export default (
 						iFrame: false,
 						decryptedHeadHash: "",
 						siteKey: dapp,
+						mode: sessionMode,
 					}),
 				);
 			}
@@ -284,6 +289,7 @@ export default (
 				siteKey: dapp,
 				countryCode,
 				headers: flatHeaders,
+				mode: sessionMode,
 			});
 
 			// Check if the IP address is blocked

packages/provider/src/tasks/frictionless/frictionlessTasks.ts

@@ -21,6 +21,7 @@ import {
 	type ContextType,
 	type GetFrictionlessCaptchaResponse,
 	type KeyringPair,
+	type ModeEnum,
 	type ProsopoConfigOutput,
 	type RequestHeaders,
 	type ScoreComponents,
@@ -97,6 +98,7 @@ export class FrictionlessManager extends CaptchaManager {
 			geolocation: params.geolocation,
 			countryCode: params.countryCode,
 			headers: params.headers,
+			mode: params.mode,
 		};
 	}
 
@@ -131,6 +133,7 @@ export class FrictionlessManager extends CaptchaManager {
 		deleted?: boolean,
 		countryCode?: string,
 		headers?: RequestHeaders,
+		mode?: ModeEnum,
 	): Promise<Session> {
 		const sessionRecord: Session = {
 			sessionId: `${getSessionIDPrefix(this.config.host)}-${uuidv4()}`,
@@ -142,6 +145,7 @@ export class FrictionlessManager extends CaptchaManager {
 			providerSelectEntropy,
 			ipAddress,
 			captchaType,
+			mode,
 			solvedImagesCount,
 			powDifficulty,
 			userSitekeyIpHash,
@@ -224,6 +228,7 @@ export class FrictionlessManager extends CaptchaManager {
 			undefined,
 			effectiveParams.countryCode,
 			effectiveParams.headers,
+			effectiveParams.mode,
 		);
 
 		return {
@@ -271,6 +276,7 @@ export class FrictionlessManager extends CaptchaManager {
 			undefined,
 			effectiveParams.countryCode,
 			effectiveParams.headers,
+			effectiveParams.mode,
 		);
 		return {
 			[ApiParams.captchaType]: CaptchaType.pow,
@@ -317,6 +323,7 @@ export class FrictionlessManager extends CaptchaManager {
 			true,
 			effectiveParams.countryCode,
 			effectiveParams.headers,
+			effectiveParams.mode,
 		);
 	}
 

packages/types-database/src/types/provider.ts

@@ -25,6 +25,7 @@ import {
 	DecisionMachineScope,
 	type DetectorKey,
 	IpAddressType,
+	ModeEnum,
 	type PendingImageCaptchaRequest,
 	type PoWCaptchaStored,
 	type Session,
@@ -370,6 +371,7 @@ export const SessionRecordSchema = new Schema<SessionRecord>({
 	providerSelectEntropy: { type: Number, required: true },
 	ipAddress: CompositeIpAddressRecordSchemaObj,
 	captchaType: { type: String, enum: CaptchaType, required: true },
+	mode: { type: String, enum: ModeEnum, required: false },
 	solvedImagesCount: { type: Number, required: false },
 	powDifficulty: { type: Number, required: false },
 	storedAtTimestamp: { type: Date, required: false, expires: ONE_DAY },
@@ -382,8 +384,8 @@ export const SessionRecordSchema = new Schema<SessionRecord>({
 	siteKey: { type: String, required: false },
 	reason: { type: String, required: false },
 	blocked: { type: Boolean, required: false },
-	geolocation: { type: String, required: false },
 	countryCode: { type: String, required: false },
+	geolocation: { type: String, required: false },
 	headers: { type: Object, required: false },
 	result: {
 		type: new Schema(

packages/types/src/api/params.ts

@@ -63,4 +63,5 @@ export enum ApiParams {
 	decisionMachineCaptchaType = "decisionMachineCaptchaType",
 	salt = "salt",
 	email = "email",
+	mode = "mode",
 }

packages/types/src/provider/api.ts

@@ -37,6 +37,7 @@ import {
 	DecisionMachineCaptchaTypeSchema,
 } from "../client/captchaType/captchaType.js";
 import { ClientSettingsSchema, Tier } from "../client/index.js";
+import { ModeEnum } from "../config/config.js";
 import {
 	DEFAULT_IMAGE_MAX_VERIFIED_TIME_CACHED,
 	DEFAULT_POW_CAPTCHA_VERIFIED_TIMEOUT,
@@ -403,6 +404,7 @@ export const GetFrictionlessCaptchaChallengeRequestBody = object({
 	[ApiParams.token]: string(),
 	[ApiParams.user]: string(),
 	[ApiParams.headHash]: string(),
+	[ApiParams.mode]: nativeEnum(ModeEnum).optional(),
 });
 
 export type GetFrictionlessCaptchaChallengeRequestBodyOutput = output<

packages/types/src/provider/database.ts

@@ -30,6 +30,7 @@ import {
 import type { IPInfoResponse } from "../api/ipapi.js";
 import { CaptchaType } from "../client/index.js";
 import type { ContextType } from "../client/settings.js";
+import { ModeEnum } from "../config/config.js";
 import {
 	type CaptchaResult,
 	type CaptchaSolution,
@@ -250,6 +251,7 @@ export const SessionSchema = object({
 	providerSelectEntropy: number(),
 	ipAddress: CompositeIpAddressSchema,
 	captchaType: nativeEnum(CaptchaType),
+	mode: nativeEnum(ModeEnum).optional(),
 	solvedImagesCount: number().optional(),
 	powDifficulty: number().optional(),
 	storedAtTimestamp: date().optional(),
@@ -285,6 +287,7 @@ export type Session = {
 	providerSelectEntropy: number;
 	ipAddress: CompositeIpAddress;
 	captchaType: CaptchaType;
+	mode?: ModeEnum;
 	solvedImagesCount?: number;
 	powDifficulty?: number;
 	storedAtTimestamp?: Date;