@prosopo/datasets 3.1.54 → 3.1.55

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

@@ -1,5 +1,5 @@
 
-> @prosopo/datasets@3.1.54 build:cjs
+> @prosopo/datasets@3.1.55 build:cjs
 > NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV
 
 ViteCommonJSConfig: .
@@ -23,20 +23,22 @@ ViteCommonJSConfig: .
     '@prosopo/util-crypto'
   ]
 }
-vite v6.4.1 building SSR bundle for production...
+The plugin "vite-tsconfig-paths" is detected. Vite now supports tsconfig paths resolution natively via the resolve.tsconfigPaths option. You can remove the plugin and set resolve.tsconfigPaths: true in your Vite config instead.
+vite v8.1.5 building ssr environment for production...
 Bundle build started
-transforming...
-Build end
-✓ 7 modules transformed.
+
+✓ 8 modules transformed.
 rendering chunks...
-dist/cjs/captcha/util.cjs                0.69 kB
-dist/cjs/captcha/index.cjs               1.48 kB
-dist/cjs/index.cjs                       1.74 kB
-dist/cjs/captcha/dataset.cjs             3.41 kB
-dist/cjs/captcha/merkle.cjs              3.70 kB
-dist/cjs/captcha/captcha.cjs             6.76 kB
-dist/cjs/tests/mocks/data/captchas.cjs  45.41 kB
-✓ built in 261ms
+computing gzip size...
+dist/cjs/captcha/util.cjs                0.59 kB │ gzip: 0.36 kB
+dist/cjs/captcha/index.cjs               1.58 kB │ gzip: 0.40 kB
+dist/cjs/index.cjs                       1.92 kB │ gzip: 0.49 kB
+dist/cjs/captcha/dataset.cjs             3.22 kB │ gzip: 1.03 kB
+dist/cjs/captcha/merkle.cjs              3.44 kB │ gzip: 1.10 kB
+dist/cjs/captcha/captcha.cjs             7.89 kB │ gzip: 2.27 kB
+dist/cjs/tests/mocks/data/captchas.cjs  41.00 kB │ gzip: 5.46 kB
+
+✓ built in 74ms
 [copy-plugin] copying /home/runner/work/captcha/captcha/packages/datasets/src/tests/mocks/data/captchas.json to /home/runner/work/captcha/captcha/packages/datasets/dist/tests/mocks/data/captchas.json
 [copy-plugin] copying /home/runner/work/captcha/captcha/packages/datasets/src/tests/mocks/data/captchas1.json to /home/runner/work/captcha/captcha/packages/datasets/dist/tests/mocks/data/captchas1.json
 [copy-plugin] copying /home/runner/work/captcha/captcha/packages/datasets/src/tests/mocks/data/captchas2.json to /home/runner/work/captcha/captcha/packages/datasets/dist/tests/mocks/data/captchas2.json

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

@@ -1,8 +1,8 @@
 
-> @prosopo/datasets@3.1.54 build:tsc
+> @prosopo/datasets@3.1.55 build:tsc
 > tsc --build --verbose
 
-10:22:25 PM - Projects in this build: 
+8:59:11 PM - Projects in this build: 
     * ../../dev/config/tsconfig.json
     * ../locale/tsconfig.json
     * ../util/tsconfig.json
@@ -12,21 +12,21 @@
     * ../common/tsconfig.json
     * tsconfig.json
 
-10:22:25 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'
+8:59:11 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:22:25 PM - Project '../locale/tsconfig.json' is up to date because newest input '../locale/src/translationKey.ts' is older than output '../locale/tsconfig.tsbuildinfo'
+8:59:11 PM - Project '../locale/tsconfig.json' is up to date because newest input '../locale/src/translationKey.ts' is older than output '../locale/tsconfig.tsbuildinfo'
 
-10:22:26 PM - Project '../util/tsconfig.json' is up to date because newest input '../util/src/url.ts' is older than output '../util/tsconfig.tsbuildinfo'
+8:59:11 PM - Project '../util/tsconfig.json' is up to date because newest input '../util/src/url.ts' is older than output '../util/tsconfig.tsbuildinfo'
 
-10:22:26 PM - Project '../logger/tsconfig.json' is up to date because newest input '../logger/src/index.ts' is older than output '../logger/tsconfig.tsbuildinfo'
+8:59:11 PM - Project '../logger/tsconfig.json' is up to date because newest input '../logger/src/index.ts' is older than output '../logger/tsconfig.tsbuildinfo'
 
-10:22:26 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'
+8:59:11 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:22:26 PM - Project '../types/tsconfig.json' is up to date because newest input '../types/src/procaptcha/api.ts' is older than output '../types/tsconfig.tsbuildinfo'
+8:59:11 PM - Project '../types/tsconfig.json' is up to date because newest input '../types/src/provider/api.ts' is older than output '../types/tsconfig.tsbuildinfo'
 
-10:22:26 PM - Project '../common/tsconfig.json' is up to date because newest input '../common/src/error.ts' is older than output '../common/tsconfig.tsbuildinfo'
+8:59:11 PM - 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'
 
-10:22:26 PM - Project 'tsconfig.json' is out of date because output file 'tsconfig.tsbuildinfo' does not exist
+8:59:11 PM - Project 'tsconfig.json' is out of date because output file 'tsconfig.tsbuildinfo' does not exist
 
-10:22:26 PM - Building project '/home/runner/work/captcha/captcha/packages/datasets/tsconfig.json'...
+8:59:11 PM - Building project '/home/runner/work/captcha/captcha/packages/datasets/tsconfig.json'...
 

package/.turbo/turbo-build.log

@@ -1,9 +1,9 @@
 
-> @prosopo/datasets@3.1.54 build
+> @prosopo/datasets@3.1.55 build
 > npm run build:cross-env -- --mode ${NODE_ENV:-development}
 
 
-> @prosopo/datasets@3.1.54 build:cross-env
+> @prosopo/datasets@3.1.55 build:cross-env
 > vite build --config vite.esm.config.ts --mode production
 
 ViteEsmConfig: .
@@ -27,20 +27,23 @@ ViteEsmConfig: .
     '@prosopo/util-crypto'
   ]
 }
-vite v6.4.1 building SSR bundle for production...
+The plugin "vite-tsconfig-paths" is detected. Vite now supports tsconfig paths resolution natively via the resolve.tsconfigPaths option. You can remove the plugin and set resolve.tsconfigPaths: true in your Vite config instead.
+vite v8.1.5 building ssr environment for production...
 Bundle build started
-transforming...
-Build end
-✓ 7 modules transformed.
+
+✓ 8 modules transformed.
 rendering chunks...
-dist/captcha/util.js                0.61 kB
-dist/captcha/index.js               1.05 kB
-dist/index.js                       1.27 kB
-dist/captcha/dataset.js             3.17 kB
-dist/captcha/merkle.js              3.47 kB
-dist/captcha/captcha.js             6.25 kB
-dist/tests/mocks/data/captchas.js  45.27 kB
-✓ built in 320ms
+computing gzip size...
+dist/_virtual/_rolldown/runtime.js   0.04 kB │ gzip: 0.06 kB
+dist/captcha/util.js                 0.57 kB │ gzip: 0.36 kB
+dist/captcha/index.js                1.00 kB │ gzip: 0.31 kB
+dist/index.js                        1.23 kB │ gzip: 0.37 kB
+dist/captcha/dataset.js              2.99 kB │ gzip: 0.98 kB
+dist/captcha/merkle.js               3.07 kB │ gzip: 1.06 kB
+dist/captcha/captcha.js              7.19 kB │ gzip: 2.19 kB
+dist/tests/mocks/data/captchas.js   40.94 kB │ gzip: 5.44 kB
+
+✓ built in 99ms
 [copy-plugin] copying /home/runner/work/captcha/captcha/packages/datasets/src/tests/mocks/data/captchas.json to /home/runner/work/captcha/captcha/packages/datasets/dist/tests/mocks/data/captchas.json
 [copy-plugin] copying /home/runner/work/captcha/captcha/packages/datasets/src/tests/mocks/data/captchas1.json to /home/runner/work/captcha/captcha/packages/datasets/dist/tests/mocks/data/captchas1.json
 [copy-plugin] copying /home/runner/work/captcha/captcha/packages/datasets/src/tests/mocks/data/captchas2.json to /home/runner/work/captcha/captcha/packages/datasets/dist/tests/mocks/data/captchas2.json

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @prosopo/datasets
 
+## 3.1.55
+### Patch Changes
+
+- e14fce6: chore(deps): bump vite to 6.4.3 and mongoose to 8.24.1, and adjust types for the mongoose 8.24 Document/ObjectId changes
+- Updated dependencies [2c47bb7]
+- Updated dependencies [0e1171c]
+- Updated dependencies [103318c]
+- Updated dependencies [270a8d8]
+- Updated dependencies [e14fce6]
+  - @prosopo/util@3.3.5
+  - @prosopo/types@4.10.0
+  - @prosopo/common@3.1.48
+  - @prosopo/logger@2.0.4
+
 ## 3.1.54
 ### Patch Changes
 

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,3 @@
+import "node:module";
+//#endregion
+export {};

package/dist/captcha/captcha.js

@@ -1,195 +1,198 @@
+import { downloadImage } from "./util.js";
 import { isHex } from "@polkadot/util";
 import { ProsopoDatasetError, ProsopoEnvError } from "@prosopo/common";
-import { DatasetWithNumericSolutionSchema, CaptchaSolutionArraySchema } from "@prosopo/types";
+import { CaptchaSolutionArraySchema, DatasetWithNumericSolutionSchema } from "@prosopo/types";
 import { at } from "@prosopo/util";
-import { hexHashArray, hexHash } from "@prosopo/util-crypto";
-import { downloadImage } from "./util.js";
-const NO_SOLUTION_VALUE = "NO_SOLUTION";
+import { hexHash, hexHashArray } from "@prosopo/util-crypto";
+//#region src/captcha/captcha.ts
+var NO_SOLUTION_VALUE = "NO_SOLUTION";
+/**
+* Parse a dataset
+* @return {JSON} captcha dataset, stored in JSON
+* @param datasetJSON
+*/
 function parseCaptchaDataset(datasetJSON) {
-  try {
-    const result = DatasetWithNumericSolutionSchema.parse(datasetJSON);
-    const result2 = {
-      format: result.format,
-      captchas: result.captchas.map((captcha) => {
-        return {
-          ...captcha,
-          solution: captcha.solution ? matchItemsToSolutions(captcha.solution, captcha.items) : [],
-          unlabelled: captcha.unlabelled ? matchItemsToSolutions(captcha.unlabelled, captcha.items) : []
-        };
-      })
-    };
-    if (result.datasetId !== void 0) result2.datasetId = result.datasetId;
-    if (result.contentTree !== void 0)
-      result2.contentTree = result.contentTree;
-    if (result.datasetContentId !== void 0)
-      result2.datasetContentId = result.datasetContentId;
-    if (result.solutionTree !== void 0)
-      result2.solutionTree = result.solutionTree;
-    return result2;
-  } catch (err) {
-    throw new ProsopoDatasetError("DATASET.DATASET_PARSE_ERROR", {
-      context: { error: err }
-    });
-  }
+	try {
+		const result = DatasetWithNumericSolutionSchema.parse(datasetJSON);
+		const result2 = {
+			format: result.format,
+			captchas: result.captchas.map((captcha) => {
+				return {
+					...captcha,
+					solution: captcha.solution ? matchItemsToSolutions(captcha.solution, captcha.items) : [],
+					unlabelled: captcha.unlabelled ? matchItemsToSolutions(captcha.unlabelled, captcha.items) : []
+				};
+			})
+		};
+		if (result.datasetId !== void 0) result2.datasetId = result.datasetId;
+		if (result.contentTree !== void 0) result2.contentTree = result.contentTree;
+		if (result.datasetContentId !== void 0) result2.datasetContentId = result.datasetContentId;
+		if (result.solutionTree !== void 0) result2.solutionTree = result.solutionTree;
+		return result2;
+	} catch (err) {
+		throw new ProsopoDatasetError("DATASET.DATASET_PARSE_ERROR", { context: { error: err } });
+	}
 }
+/**
+* Make sure captcha solutions are in the correct format
+* @param {JSON} captchaJSON captcha solutions received from the api
+* @return {CaptchaSolution[]} an array of parsed and sorted captcha solutions
+*/
 function parseAndSortCaptchaSolutions(captchaJSON) {
-  try {
-    return CaptchaSolutionArraySchema.parse(captchaJSON).map((captcha) => ({
-      ...captcha,
-      solution: captcha.solution.sort()
-    }));
-  } catch (err) {
-    throw new ProsopoDatasetError("DATASET.SOLUTION_PARSE_ERROR", {
-      context: { error: err }
-    });
-  }
+	try {
+		return CaptchaSolutionArraySchema.parse(captchaJSON).map((captcha) => ({
+			...captcha,
+			solution: captcha.solution.sort()
+		}));
+	} catch (err) {
+		throw new ProsopoDatasetError("DATASET.SOLUTION_PARSE_ERROR", { context: { error: err } });
+	}
 }
 function captchaSort(a, b) {
-  return a.captchaId.localeCompare(b.captchaId);
+	return a.captchaId.localeCompare(b.captchaId);
 }
 function sortAndComputeHashes(received, stored) {
-  received.sort(captchaSort);
-  stored.sort(captchaSort);
-  return stored.map(
-    ({ salt, items = [], target = "", captchaId, solved }, index) => {
-      const item = at(received, index);
-      if (captchaId !== item.captchaId) {
-        throw new ProsopoEnvError("CAPTCHA.ID_MISMATCH");
-      }
-      return {
-        hash: computeCaptchaHash(
-          {
-            solution: solved ? item.solution : [],
-            salt,
-            items,
-            target
-          },
-          true,
-          true,
-          false
-        ),
-        captchaId
-      };
-    }
-  );
+	received.sort(captchaSort);
+	stored.sort(captchaSort);
+	return stored.map(({ salt, items = [], target = "", captchaId, solved }, index) => {
+		const item = at(received, index);
+		if (captchaId !== item.captchaId) throw new ProsopoEnvError("CAPTCHA.ID_MISMATCH");
+		return {
+			hash: computeCaptchaHash({
+				solution: solved ? item.solution : [],
+				salt,
+				items,
+				target
+			}, true, true, false),
+			captchaId
+		};
+	});
 }
+/**
+* Take an array of CaptchaSolutions and Captchas and check if the solutions are the same for each pair
+* @param  {CaptchaSolution[]} received
+* @param solutions
+* @param totalImages
+* @param  {number} threshold the percentage of captchas that must be correct to return true
+* @return {boolean}
+*/
 function compareCaptchaSolutions(received, solutions, totalImages, threshold) {
-  received.sort(captchaSort);
-  solutions.sort(captchaSort);
-  if (received.length !== solutions.length) {
-    return false;
-  }
-  if (received.length && solutions.length && received.length === solutions.length) {
-    const captchaIdMismatch = received.some(
-      (captcha, index) => solutions[index] && captcha.captchaId !== solutions[index].captchaId
-    );
-    if (captchaIdMismatch) {
-      return false;
-    }
-  }
-  return received.every((captcha, index) => {
-    const sortedReceivedSolution = captcha.solution.sort();
-    const targetSolution = solutions[index]?.solution.sort();
-    if (!targetSolution) {
-      return false;
-    }
-    const incorrectCount = sortedReceivedSolution.filter(
-      (solution) => !targetSolution.includes(solution)
-    ).length;
-    const missingCount = targetSolution.filter(
-      (solution) => !sortedReceivedSolution.includes(solution)
-    ).length;
-    const totalIncorrect = incorrectCount + missingCount;
-    const percentageCorrect = 1 - totalIncorrect / totalImages;
-    return percentageCorrect >= threshold;
-  });
+	received.sort(captchaSort);
+	solutions.sort(captchaSort);
+	if (received.length !== solutions.length) return false;
+	if (received.length && solutions.length && received.length === solutions.length) {
+		if (received.some((captcha, index) => solutions[index] && captcha.captchaId !== solutions[index].captchaId)) return false;
+	}
+	return received.every((captcha, index) => {
+		const sortedReceivedSolution = captcha.solution.sort();
+		const targetSolution = solutions[index]?.solution.sort();
+		if (!targetSolution) return false;
+		return 1 - (sortedReceivedSolution.filter((solution) => !targetSolution.includes(solution)).length + targetSolution.filter((solution) => !sortedReceivedSolution.includes(solution)).length) / totalImages >= threshold;
+	});
 }
+/**
+* Compute the hash of various types of captcha
+* @param  {Captcha} captcha
+* @param  {boolean} includeSolution
+* @param  {boolean} includeSalt
+* @param  {boolean} sortItemHashes
+* @return {string} the hex string hash
+*/
 function computeCaptchaHash(captcha, includeSolution, includeSalt, sortItemHashes) {
-  try {
-    const itemHashes = captcha.items.map((item, index) => {
-      if (item.hash) {
-        return item.hash;
-      }
-      throw new ProsopoDatasetError("CAPTCHA.MISSING_ITEM_HASH", {
-        context: {
-          computeCaptchaHashName: computeCaptchaHash.name,
-          index
-        }
-      });
-    });
-    return hexHashArray([
-      captcha.target,
-      // empty array hashes as empty string, undefined solution results in the array [`NO_SOLUTION`]
-      // [undefined] also hashes as empty string, which is why we don't use it
-      ...includeSolution ? getSolutionValueToHash(captcha.solution) : [],
-      includeSalt ? captcha.salt : "",
-      sortItemHashes ? itemHashes.sort() : itemHashes
-    ]);
-  } catch (err) {
-    throw new ProsopoDatasetError("DATASET.HASH_ERROR", {
-      context: { error: err }
-    });
-  }
+	try {
+		const itemHashes = captcha.items.map((item, index) => {
+			if (item.hash) return item.hash;
+			throw new ProsopoDatasetError("CAPTCHA.MISSING_ITEM_HASH", { context: {
+				computeCaptchaHashName: computeCaptchaHash.name,
+				index
+			} });
+		});
+		return hexHashArray([
+			captcha.target,
+			...includeSolution ? getSolutionValueToHash(captcha.solution) : [],
+			includeSalt ? captcha.salt : "",
+			sortItemHashes ? itemHashes.sort() : itemHashes
+		]);
+	} catch (err) {
+		throw new ProsopoDatasetError("DATASET.HASH_ERROR", { context: { error: err } });
+	}
 }
+/** Return the sorted solution value or ['NO_SOLUTION'] if there is no solution. Ensures that an empty array is a valid
+* solution
+* @param solution
+*/
 function getSolutionValueToHash(solution) {
-  return solution !== void 0 ? solution.sort() : [NO_SOLUTION_VALUE];
+	return solution !== void 0 ? solution.sort() : [NO_SOLUTION_VALUE];
 }
+/** Compute the hash of a captcha item, downloading the image if necessary
+* @param  {Item} item
+* @return {Promise<HashedItem>} the hex string hash of the item
+*/
 async function computeItemHash(item) {
-  if (item.type === "text") {
-    return { ...item, hash: hexHash(item.data) };
-  }
-  if (item.type === "image") {
-    return { ...item, hash: hexHash(await downloadImage(item.data)) };
-  }
-  throw new ProsopoDatasetError("CAPTCHA.INVALID_ITEM_FORMAT");
+	if (item.type === "text") return {
+		...item,
+		hash: hexHash(item.data)
+	};
+	if (item.type === "image") return {
+		...item,
+		hash: hexHash(await downloadImage(item.data))
+	};
+	throw new ProsopoDatasetError("CAPTCHA.INVALID_ITEM_FORMAT");
 }
+/**
+* Converts an indexed captcha solution to a hashed captcha solution or simply returns the hash if it is already hashed
+* @return {HashedSolution[]}
+* @param {RawSolution[] | HashedSolution[]} solutions
+* @param {Item[]} items
+*/
 function matchItemsToSolutions(solutions, items) {
-  if (!items) {
-    return [];
-  }
-  return solutions.map((solution) => {
-    if (typeof solution === "string" && isHex(solution)) {
-      if (!items?.some((item) => item.hash === solution)) {
-        throw new ProsopoDatasetError("CAPTCHA.INVALID_ITEM_HASH");
-      }
-      return solution;
-    }
-    if (typeof solution === "number") {
-      const item = at(items, solution);
-      return item.hash;
-    }
-    throw new ProsopoDatasetError("CAPTCHA.INVALID_SOLUTION_TYPE");
-  });
+	if (!items) return [];
+	return solutions.map((solution) => {
+		if (typeof solution === "string" && isHex(solution)) {
+			if (!items?.some((item) => item.hash === solution)) throw new ProsopoDatasetError("CAPTCHA.INVALID_ITEM_HASH");
+			return solution;
+		}
+		if (typeof solution === "number") return at(items, solution).hash;
+		throw new ProsopoDatasetError("CAPTCHA.INVALID_SOLUTION_TYPE");
+	});
 }
+/**
+* Create a unique solution commitment
+* @param  {CaptchaSolution} captcha
+* @return {string} the hex string hash
+*/
 function computeCaptchaSolutionHash(captcha) {
-  return hexHashArray([
-    captcha.captchaId,
-    captcha.captchaContentId,
-    [...captcha.solution].sort(),
-    captcha.salt
-  ]);
+	return hexHashArray([
+		captcha.captchaId,
+		captcha.captchaContentId,
+		[...captcha.solution].sort(),
+		captcha.salt
+	]);
 }
+/**
+* Compute hash for an array of captcha ids, userAccount, and salt, which serves as the identifier for a pending request
+* @param  {string[]} captchaIds
+* @param  {string} userAccount
+* @param  {string} salt
+* @return {string}
+*/
 function computePendingRequestHash(captchaIds, userAccount, salt) {
-  return hexHashArray([...captchaIds.sort(), userAccount, salt]);
+	return hexHashArray([
+		...captchaIds.sort(),
+		userAccount,
+		salt
+	]);
 }
+/**
+* Parse the image items in a captcha and pass back a URI if they exist
+* @param  {Item} item
+* @param  {AssetsResolver} assetsResolver
+*/
 function parseCaptchaAssets(item, assetsResolver) {
-  return {
-    ...item,
-    data: assetsResolver?.resolveAsset(item.data).getURL() || item.data
-  };
+	return {
+		...item,
+		data: assetsResolver?.resolveAsset(item.data).getURL() || item.data
+	};
 }
-export {
-  NO_SOLUTION_VALUE,
-  captchaSort,
-  compareCaptchaSolutions,
-  computeCaptchaHash,
-  computeCaptchaSolutionHash,
-  computeItemHash,
-  computePendingRequestHash,
-  getSolutionValueToHash,
-  matchItemsToSolutions,
-  parseAndSortCaptchaSolutions,
-  parseCaptchaAssets,
-  parseCaptchaDataset,
-  sortAndComputeHashes
-};
+//#endregion
+export { NO_SOLUTION_VALUE, captchaSort, compareCaptchaSolutions, computeCaptchaHash, computeCaptchaSolutionHash, computeItemHash, computePendingRequestHash, getSolutionValueToHash, matchItemsToSolutions, parseAndSortCaptchaSolutions, parseCaptchaAssets, parseCaptchaDataset, sortAndComputeHashes };