@sjcrh/proteinpaint-types 2.128.1 → 2.129.0

package/package.json

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

package/src/dataset.ts

@@ -614,6 +614,19 @@ type CnvSegment = {
 			[key: string]: any
 		}
 	}
+
+	/** in mds3 tk view and gdc cnv tool, when number of segments from view region exceeds this cutoff, it's piled up into density view to speed up
+	overrides default 1000
+	this cutoff does not apply to other uses beyond mds3 tk, including matrix and geneVariant
+	*/
+	densityViewCutoff?: number
+
+	/** this cutoff is applied in ds.queries.cnv.get(), in that up to this number of segments will be returned
+	overrides default 10k
+	this applies to matrix, geneVariant, and mds3 tk
+	todo there lacks a way for getter to message downstream code of exceeding limit
+	*/
+	maxReturnCutoff?: number
 }
 
 /*
@@ -1925,10 +1938,6 @@ export type PreInit = {
 		status 4xx are not considered recoverable (client-related request errors)
 	*/
 	getStatus: () => Promise<PreInitStatus>
-	/** number of milliseconds to wait before calling th preInit.getStatus() again */
-	retryDelay?: number
-	/** maximum number of times to call preInit.getStatus() before giving up */
-	retryMax?: number
 	/**
 	 * dev only, used to test preInit handling by simulating different
 	 * responses in a known sequence of steps that may edit the preInit
@@ -1963,8 +1972,12 @@ export type Mds3 = BaseMds & {
 	init?: {
 		/** number of milliseconds to wait before calling th preInit.getStatus() again */
 		retryDelay?: number
-		/** maximum number of times to call preInit.getStatus() before giving up */
+		/** maximum number of tries to complete initialization, including preInit.getStatus() before validation steps
+		 * and the nonblocking steps after validation. Before the retryMax is reached, errors are considered recoverable;
+		 * errors when retryMax is reached will be fatal. */
 		retryMax?: number
+		/** option to trigger mds3InitNonblocking() on this dataset */
+		hasNonblockingSteps?: boolean
 		/** server-computed cumulative count of the attempted init retries */
 		currentRetry?: number
 		/**