@sjcrh/proteinpaint-types 2.138.3-4 → 2.138.3-5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sjcrh/proteinpaint-types",
-  "version": "2.138.3-4",
+  "version": "2.138.3-5",
   "type": "module",
   "description": "Shared type definitions between ProteinPaint server and client code",
   "main": "src/index.ts",

package/src/dataset.ts

@@ -1380,14 +1380,29 @@ export type Termdb = {
 	/** Terms */
 	termIds?: TermIds
 	/**
-	 * The required minimum number of samples with data as queried with getData() or other code,
+	 * Check for the required minimum number of samples with data as queried with getData() or other code,
 	 * in order to minimize the ease of extracting identifiable information from aggregate data
 	 * in server response
 	 *
-	 * sampleCount:   the number of samples with matching data from one or more queried terms
-	 * q          :   req.query as processed through app middleware (pre-parsed, may have req.body props, __protectec__, etc)
+	 * q            :   req.query as processed through app middleware (pre-parsed, may have req.body props, __protectec__, etc)
+	 *
+	 * data{
+	 *   sampleCount:   the number of samples with matching data from one or more queried terms
+	 * }
+	 *
+	 * returns: {minSampleSize, canAccess}, see below
 	 */
-	hasMinSampleSize?: (sampleCount: number, q: any) => boolean
+	checkAccessToSampleData?: (
+		q: any,
+		data: { sampleCount: number }
+	) => {
+		/** the required minimum sample size for the current user,
+		 * may be dependent on login status or other context
+		 * */
+		minSampleSize: number
+		/** whether downstreadm backend code can proceed */
+		canAccess: boolean
+	}
 	/** if true, backend is allowed to send sample names to client in charts */
 	displaySampleIds?: (clientAuthResult: any) => boolean
 	converSampleIds?: boolean