@prosopo/database 4.1.4 → 4.2.0

package/.turbo/turbo-build$colon$cjs.log

@@ -45,9 +45,9 @@ dist/cjs/index.cjs                         1.66 kB │ gzip:  0.49 kB
 dist/cjs/databases/client.cjs              1.79 kB │ gzip:  0.77 kB
 dist/cjs/mongooseOptions.cjs               3.74 kB │ gzip:  1.56 kB
 dist/cjs/base/mongo.cjs                    4.27 kB │ gzip:  1.41 kB
-dist/cjs/databases/centralDbStreamer.cjs   5.53 kB │ gzip:  1.37 kB
-dist/cjs/databases/captcha.cjs             7.38 kB │ gzip:  2.18 kB
+dist/cjs/databases/centralDbStreamer.cjs   6.40 kB │ gzip:  1.52 kB
+dist/cjs/databases/captcha.cjs             8.20 kB │ gzip:  2.36 kB
 dist/cjs/redisCache.cjs                   14.31 kB │ gzip:  4.46 kB
-dist/cjs/databases/provider.cjs           60.73 kB │ gzip: 12.01 kB
+dist/cjs/databases/provider.cjs           67.79 kB │ gzip: 13.13 kB
 
-✓ built in 74ms
+✓ built in 68ms

package/.turbo/turbo-build$colon$tsc.log

@@ -1,5 +1,5 @@
 $ tsc --build --verbose
-1:37:55 PM - Projects in this build: 
+10:12:01 AM - Projects in this build: 
     * ../../dev/config/tsconfig.json
     * ../util/tsconfig.json
     * ../locale/tsconfig.json
@@ -14,31 +14,31 @@ $ tsc --build --verbose
     * ../types-database/tsconfig.json
     * tsconfig.json
 
-1:37:55 PM - Project '../../dev/config/tsconfig.json' is up to date because newest input '../../dev/config/src/webpack/webpack.config.ts' is older than output '../../dev/config/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../../dev/config/tsconfig.json' is up to date because newest input '../../dev/config/src/webpack/webpack.config.ts' is older than output '../../dev/config/tsconfig.tsbuildinfo'
 
-1:37:55 PM - Project '../util/tsconfig.json' is up to date because newest input '../util/src/url.ts' is older than output '../util/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../util/tsconfig.json' is up to date because newest input '../util/src/table.ts' is older than output '../util/tsconfig.tsbuildinfo'
 
-1:37:55 PM - Project '../locale/tsconfig.json' is up to date because newest input '../locale/src/translationKey.ts' is older than output '../locale/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../locale/tsconfig.json' is up to date because newest input '../locale/src/translationKey.ts' is older than output '../locale/tsconfig.tsbuildinfo'
 
-1:37:55 PM - Project '../logger/tsconfig.json' is up to date because newest input '../logger/src/index.ts' is older than output '../logger/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../logger/tsconfig.json' is up to date because newest input '../logger/src/logger.ts' is older than output '../logger/tsconfig.tsbuildinfo'
 
-1:37:55 PM - Project '../util-crypto/tsconfig.json' is up to date because newest input '../util-crypto/src/types.ts' is older than output '../util-crypto/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../util-crypto/tsconfig.json' is up to date because newest input '../util-crypto/src/types.ts' is older than output '../util-crypto/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../types/tsconfig.json' is up to date because newest input '../types/src/types.test-d.ts' is older than output '../types/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../types/tsconfig.json' is up to date because newest input '../types/src/types.test-d.ts' is older than output '../types/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../common/tsconfig.json' is up to date because newest input '../common/src/index.ts' is older than output '../common/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../common/tsconfig.json' is up to date because newest input '../common/src/tests/utils/batches.unit.test.ts' is older than output '../common/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../api-route/tsconfig.json' is up to date because newest input '../api-route/src/apiRoutes.ts' is older than output '../api-route/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../api-route/tsconfig.json' is up to date because newest input '../api-route/src/apiRoutes.ts' is older than output '../api-route/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../redis-client/tsconfig.json' is up to date because newest input '../redis-client/src/index.ts' is older than output '../redis-client/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../redis-client/tsconfig.json' is up to date because newest input '../redis-client/src/index.ts' is older than output '../redis-client/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../api/tsconfig.json' is up to date because newest input '../api/src/tests/apiHarness.ts' is older than output '../api/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../api/tsconfig.json' is up to date because newest input '../api/src/index.ts' is older than output '../api/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../user-access-policy/tsconfig.json' is up to date because newest input '../user-access-policy/src/ruleRecord.ts' is older than output '../user-access-policy/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../user-access-policy/tsconfig.json' is up to date because newest input '../user-access-policy/src/transformRule.ts' is older than output '../user-access-policy/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project '../types-database/tsconfig.json' is up to date because newest input '../types-database/src/index.ts' is older than output '../types-database/tsconfig.tsbuildinfo'
+10:12:01 AM - Project '../types-database/tsconfig.json' is up to date because newest input '../types-database/src/types.test-d.ts' is older than output '../types-database/tsconfig.tsbuildinfo'
 
-1:37:56 PM - Project 'tsconfig.json' is out of date because output file 'tsconfig.tsbuildinfo' does not exist
+10:12:01 AM - Project 'tsconfig.json' is out of date because output file 'tsconfig.tsbuildinfo' does not exist
 
-1:37:56 PM - Building project '/home/runner/work/captcha/captcha/packages/database/tsconfig.json'...
+10:12:01 AM - Building project '/home/runner/work/captcha/captcha/packages/database/tsconfig.json'...
 

package/.turbo/turbo-build.log

@@ -46,9 +46,9 @@ dist/index.js                         1.07 kB │ gzip:  0.38 kB
 dist/databases/client.js              1.70 kB │ gzip:  0.75 kB
 dist/mongooseOptions.js               3.58 kB │ gzip:  1.53 kB
 dist/base/mongo.js                    4.01 kB │ gzip:  1.32 kB
-dist/databases/centralDbStreamer.js   5.47 kB │ gzip:  1.35 kB
-dist/databases/captcha.js             7.30 kB │ gzip:  2.17 kB
+dist/databases/centralDbStreamer.js   6.33 kB │ gzip:  1.51 kB
+dist/databases/captcha.js             8.13 kB │ gzip:  2.36 kB
 dist/redisCache.js                   14.26 kB │ gzip:  4.44 kB
-dist/databases/provider.js           59.41 kB │ gzip: 12.03 kB
+dist/databases/provider.js           66.18 kB │ gzip: 13.13 kB
 
-✓ built in 144ms
+✓ built in 88ms

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @prosopo/database
 
+## 4.2.0
+### Minor Changes
+
+- b299a91: An audio challenge, offered only as an accessibility alternative, like reCAPTCHA's audio option. The user hears a short sequence of spoken digits and types them in.
+  
+  It is off by default and needs two switches. Prosopo has to turn on the `captchaTypeFeatureFlags.audio` feature flag for the site, which the site owner cannot do, and the site owner has to set `audioAccessibilityEnabled`. When both are on, image, puzzle and icon-order challenges show a "Use audio instead" button. Pressing it swaps the visual challenge for the audio one. After a wrong answer the user stays on audio and gets a fresh clip.
+  
+  Audio is never a captcha type that can be selected or routed to. A site's `captchaType`, traffic-filter categories, Restrict rules and the site-key CLI all reject it, and routing, PoW escalation and the severity tiers leave it out. The provider only serves audio against the visual session the user was already given, and only on a site with both switches on; any other audio request is refused before the session is used up, and a request without a session is always refused.
+  
+  The spoken digits are synthesised by `@prosopo/audio-assets`, so there is no recorded set of clips to collect. The answer never leaves the provider, and a challenge can be submitted and verified only once, even under concurrent requests. `@prosopo/procaptcha-audio` is the widget. It and the "Use audio instead" button are built on the shared widget code in `@prosopo/procaptcha-common`, and the provider side is built on the shared interactive-captcha code that puzzle and icon-order use.
+  
+  The demo playground has audio pages, and there is an end-to-end test for it.
+- e13d7a8: New captcha type: `iconOrder`. The user is shown a frame of icons and a legend, and clicks the legend's icons in the order given.
+  
+  Icon-order is off by default. Only Prosopo can switch it on for a site, with the `captchaTypeFeatureFlags.iconOrder` feature flag; the site owner cannot. A site without the flag is never served icon-order by any route, and the challenge endpoint refuses it. Once the flag is on, the owner can still keep icon-order out of the frictionless flow with `frictionlessTypes.iconOrder`, the same way as image and puzzle.
+  
+  The answer never leaves the provider. Icon positions are stored on the challenge record, and the widget receives only the rendered frame and legend. Grading checks order as well as position, and each icon's hit radius scales with its size. Verifying a token is single-use under concurrent requests.
+  
+  `@prosopo/icon-order-assets` draws the imagery, and `@prosopo/procaptcha-icon-order` is the widget. Its text is translated into every supported language.
+  
+  Puzzle and icon-order now share their server code: challenge and solution handlers, the verify route, the submit and verify pipeline, and the database record methods. The widget code they have in common moves into `@prosopo/procaptcha-common`: the lazy mount wrapper, manager expiry and dispose, spent-session handling, behavioural data encryption and trusted click coordinates. Puzzle's behaviour is unchanged.
+  
+  The demo playground has icon-order pages, and there is an end-to-end test for it.
+
+### Patch Changes
+
+- Updated dependencies [b299a91]
+- Updated dependencies [e13d7a8]
+- Updated dependencies [270395d]
+  - @prosopo/types@5.14.0
+  - @prosopo/types-database@5.9.0
+  - @prosopo/user-access-policy@3.14.16
+  - @prosopo/common@3.1.63
+
 ## 4.1.4
 ### Patch Changes
 

package/dist/cjs/databases/captcha.cjs

@@ -26,6 +26,16 @@ var CAPTCHA_TABLES = [
 		collectionName: "puzzlecaptcha",
 		modelName: "PuzzleCaptcha",
 		schema: _prosopo_types_database.StoredPuzzleCaptchaRecordSchema
+	},
+	{
+		collectionName: "audiocaptcha",
+		modelName: "AudioCaptcha",
+		schema: _prosopo_types_database.StoredAudioCaptchaRecordSchema
+	},
+	{
+		collectionName: "iconordercaptcha",
+		modelName: "IconOrderCaptcha",
+		schema: _prosopo_types_database.StoredIconOrderCaptchaRecordSchema
 	}
 ];
 var CaptchaDatabase = class CaptchaDatabase extends require_mongo.MongoDatabase {
@@ -111,7 +121,7 @@ var CaptchaDatabase = class CaptchaDatabase extends require_mongo.MongoDatabase
 			providedIp: CaptchaDatabase.normaliseCompositeIp(doc.providedIp)
 		};
 	}
-	async saveCaptchas(sessionEvents, imageCaptchaEvents, powCaptchaEvents, puzzleCaptchaEvents = []) {
+	async saveCaptchas(sessionEvents, imageCaptchaEvents, powCaptchaEvents, puzzleCaptchaEvents = [], iconOrderCaptchaEvents = [], audioCaptchaEvents = []) {
 		await this.connect();
 		if (sessionEvents.length) {
 			const result = await this.tables.session.bulkWrite(sessionEvents.map((document) => {
@@ -173,35 +183,41 @@ var CaptchaDatabase = class CaptchaDatabase extends require_mongo.MongoDatabase
 				msg: "Mongo Saved PoW Events"
 			}));
 		}
-		if (puzzleCaptchaEvents.length) {
-			const result = await this.tables.puzzlecaptcha.bulkWrite(puzzleCaptchaEvents.map((doc) => {
-				const { _id, ...safeDoc } = doc;
-				const normalised = CaptchaDatabase.normaliseDocCompositeIps(safeDoc);
-				return { updateOne: {
-					filter: { challenge: normalised.challenge },
-					update: { $set: normalised },
-					upsert: true
-				} };
-			}));
-			logger.info(() => ({
-				data: {
-					upsertedCount: result.upsertedCount,
-					matchedCount: result.matchedCount,
-					modifiedCount: result.modifiedCount,
-					totalProcessed: puzzleCaptchaEvents.length
-				},
-				msg: "Mongo Saved Puzzle Events"
-			}));
-		}
+		await this.upsertChallengeRecords("puzzlecaptcha", puzzleCaptchaEvents, "Mongo Saved Puzzle Events");
+		await this.upsertChallengeRecords("audiocaptcha", audioCaptchaEvents, "Mongo Saved Audio Events");
+		await this.upsertChallengeRecords("iconordercaptcha", iconOrderCaptchaEvents, "Mongo Saved Icon Order Events");
 		await this.close();
 	}
+	async upsertChallengeRecords(table, records, msg) {
+		if (!records.length) return;
+		const result = await this.tables[table].bulkWrite(records.map((doc) => {
+			const { _id, ...safeDoc } = doc;
+			const normalised = CaptchaDatabase.normaliseDocCompositeIps(safeDoc);
+			return { updateOne: {
+				filter: { challenge: normalised.challenge },
+				update: { $set: normalised },
+				upsert: true
+			} };
+		}));
+		logger.info(() => ({
+			data: {
+				upsertedCount: result.upsertedCount,
+				matchedCount: result.matchedCount,
+				modifiedCount: result.modifiedCount,
+				totalProcessed: records.length
+			},
+			msg
+		}));
+	}
 	async getCaptchas(filter = {}, limit = 100) {
 		await this.connect();
 		try {
 			return {
 				userCommitmentRecords: await this.tables.commitment.find(filter).limit(limit).lean(),
 				powCaptchaRecords: await this.tables.powcaptcha.find(filter).limit(limit).lean(),
-				puzzleCaptchaRecords: await this.tables.puzzlecaptcha.find(filter).limit(limit).lean()
+				puzzleCaptchaRecords: await this.tables.puzzlecaptcha.find(filter).limit(limit).lean(),
+				audioCaptchaRecords: await this.tables.audiocaptcha.find(filter).limit(limit).lean(),
+				iconOrderCaptchaRecords: await this.tables.iconordercaptcha.find(filter).limit(limit).lean()
 			};
 		} catch (error) {
 			throw new _prosopo_common.ProsopoDBError("DATABASE.QUERY_ERROR", {

package/dist/cjs/databases/centralDbStreamer.cjs

@@ -113,27 +113,45 @@ var CentralDbStreamer = class CentralDbStreamer {
 	* Fire-and-forget: errors are logged, never thrown.
 	*/
 	streamPuzzleRecord(record, markStored) {
+		this.streamChallengeRecord("puzzlecaptcha", "puzzle", record, markStored);
+	}
+	/**
+	* Stream a partial puzzle update by fetching the full record first, then upserting.
+	*/
+	streamPuzzleUpdate(getFullRecord, markStored) {
+		this.streamChallengeUpdate(getFullRecord, (record) => this.streamPuzzleRecord(record, markStored), "puzzle");
+	}
+	streamAudioRecord(record, markStored) {
+		this.streamChallengeRecord("audiocaptcha", "audio", record, markStored);
+	}
+	streamAudioUpdate(getFullRecord, markStored) {
+		this.streamChallengeUpdate(getFullRecord, (record) => this.streamAudioRecord(record, markStored), "audio");
+	}
+	streamIconOrderRecord(record, markStored) {
+		this.streamChallengeRecord("iconordercaptcha", "icon-order", record, markStored);
+	}
+	streamIconOrderUpdate(getFullRecord, markStored) {
+		this.streamChallengeUpdate(getFullRecord, (record) => this.streamIconOrderRecord(record, markStored), "icon-order");
+	}
+	streamChallengeRecord(table, label, record, markStored) {
 		const timestamp = this.getRecordTimestamp(record);
 		this.ensureConnected().then(() => {
 			const { _id, ...safeDoc } = record;
-			return this.db.tables.puzzlecaptcha.updateOne({ challenge: safeDoc.challenge }, { $set: safeDoc }, { upsert: true });
+			return this.db.tables[table].updateOne({ challenge: safeDoc.challenge }, { $set: safeDoc }, { upsert: true });
 		}).then(() => markStored?.(timestamp)).catch((err) => {
 			this.logger.error(() => ({
 				err,
-				msg: "Failed to stream puzzle record to central DB"
+				msg: `Failed to stream ${label} record to central DB`
 			}));
 		});
 	}
-	/**
-	* Stream a partial puzzle update by fetching the full record first, then upserting.
-	*/
-	streamPuzzleUpdate(getFullRecord, markStored) {
+	streamChallengeUpdate(getFullRecord, stream, label) {
 		getFullRecord().then((record) => {
-			if (record) this.streamPuzzleRecord(record, markStored);
+			if (record) stream(record);
 		}).catch((err) => {
 			this.logger.error(() => ({
 				err,
-				msg: "Failed to fetch puzzle record for central DB streaming"
+				msg: `Failed to fetch ${label} record for central DB streaming`
 			}));
 		});
 	}