@sjcrh/proteinpaint-types 2.129.2 → 2.129.6-2b2fdc7ee.0

package/package.json

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

package/src/dataset.ts

@@ -1495,41 +1495,51 @@ type MutationSet = {
 	fusion: string
 }
 
-type BaseDtEntry = {
+/** different methods to return samples with assay availability info */
+type DtAssayAvailability = DtAssayAvailabilityGetter | DtAssayAvailabilityTerm
+
+/** using ds-supplied getter */
+type DtAssayAvailabilityGetter = {
+	get: (q: any) => any
+}
+/** using dictionary term */
+type DtAssayAvailabilityTerm = {
+	/** id of this assay term for this dt */
 	term_id: string
+	/** optional label */
+	label?: string
+	/** categories meaning the sample has this assay */
 	yes: { value: string[] }
+	/** categories meaning the sample doesn't have this assay */
 	no: { value: string[] }
-	label?: string
-}
-
-type SNVByOrigin = {
-	[index: string]: BaseDtEntry
-}
-
-type DtEntrySNV = {
-	byOrigin: SNVByOrigin
-}
-
-type ByDt = {
-	/** SNVs differentiate by sample origin. Non-SNV, no differentiation*/
-	[index: number]: DtEntrySNV | BaseDtEntry
 }
 
-type AssayValuesEntry = {
-	[index: string]: { label: string; color: string }
+type DtAssayAvailabilityByOrigin = {
+	byOrigin: {
+		/** each key is an origin value or category */
+		[index: string]: DtAssayAvailability
+	}
 }
 
-type AssaysEntry = {
-	id: string
-	name: string
-	type: string
-	values?: AssayValuesEntry
+type Mds3AssayAvailability = {
+	/** object of key-value pairs. keys are dt values */
+	byDt: {
+		/** each index is a dt value */
+		[index: number]: DtAssayAvailabilityByOrigin | DtAssayAvailability
+	}
 }
 
-type AssayAvailability = {
-	byDt?: ByDt
+// mds legacy; delete when all are migrated to mds3
+type LegacyAssayAvailability = {
 	file?: string
-	assays?: AssaysEntry[]
+	assays?: {
+		id: string
+		name: string
+		type: string
+		values?: {
+			[index: string]: { label: string; color: string }
+		}
+	}[]
 }
 
 export type CumBurdenData = {
@@ -1887,7 +1897,7 @@ type ViewMode = {
 /*** types supporting Mds Dataset types ***/
 type BaseMds = {
 	genome?: string //Not declared in TermdbTest
-	assayAvailability?: AssayAvailability
+	assayAvailability?: Mds3AssayAvailability | LegacyAssayAvailability
 }
 
 export type Mds = BaseMds & {
@@ -1965,6 +1975,14 @@ export type isSupportedChartCallbacks = {
 }
 
 export type Mds3 = BaseMds & {
+	/** set in initGenomesDs.js during launch, should use .genomename instead of .genome */
+	genomename?: string // use this
+	genome?: string // avoid using it
+	/** server-side genome obj to which this ds belongs to is attached here in initGenomesDs.js during launch, 
+	so this obj can be conveniently available to server side functions without having to introduce extra param
+	TODO apply Genome type
+	*/
+	genomeObj?: any
 	label?: Title
 	isMds3: boolean
 	loadWithoutBlocking?: boolean