@sjcrh/proteinpaint-types 2.163.0 → 2.163.1

package/package.json

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

package/src/dataset.ts

@@ -384,19 +384,12 @@ type SvFusion = {
 }
 
 type SingleSampleMutationQuery = {
-	/** for native ds, each file should contain a stringified json array with elements below
-	see file server/test/tp/files/hg38/TermdbTest/mutationpersample/3318 for example
-	for non-native ds, the getter should return an json array with same structure
+	/** ds supplied getter
+	returns same json array as native. see example below
 	*/
-	src: 'native' | 'gdcapi' | string
-	/** which property of client mutation object to retrieve sample identifier for
-	 * querying single sample data with */
+	get?: (f: any) => void
+	/** which property of client mutation object to retrieve sample identifier for querying single sample data with */
 	sample_id_key: string
-	/** only required for src=native
-	folder contains a set of files, one file per sample, file named by sample name
-	each file contains a stringified json array of mutation/cnv/sv entries (aka mlst)
-	*/
-	folder?: string
 	/** disco plot will be launched when singleSampleMutation is enabled. supply customization options here */
 	discoPlot?: {
 		/** if true, disco plot will hide chrM, due to reason e.g. this dataset doesn't have data on chrM */
@@ -404,6 +397,16 @@ type SingleSampleMutationQuery = {
 		/** if true, filter mutations by predefined geneset by default */
 		prioritizeGeneLabelsByGeneSets?: true
 	}
+	/** rest of properties are required for native ds without ds-supplied getter
+	TODO migrate gdc to get() and delete .src=native
+	*/
+	src?: 'native' | 'gdcapi' | string
+	/** only required for src=native
+	folder contains a set of files, one file per sample, file named by sample name
+	each file contains a stringified json array of mutation/cnv/sv entries (aka mlst). see example
+	https://github.com/stjude/proteinpaint/blob/master/server/test/tp/files/hg38/TermdbTest/mutationpersample/3318
+	*/
+	folder?: string
 }
 
 type NIdataQuery = {
@@ -1572,6 +1575,25 @@ keep this setting here for reason of:
 	isTermVisible?: (clientAuthResult: any, ids: string) => boolean
 	hiddenIds?: string[]
 	getAdditionalFilter?: (__protected__: any, term: any) => Filter | undefined
+	/** collections of numeric dictionary terms that are related and can be used together in some plots
+	 */
+	numericTermCollections?: NumericTermCollection[]
+}
+
+type NumericTermCollection = {
+	/** human readable name for this collection */
+	name: string
+	/** array of dictionary numeric term ids belonging to this collection */
+	termIds: string[]
+	/** array of branch term ids belonging to this collection */
+	branchIds: string[]
+	/** preconfigured cohort-level plots for this collection */
+	plots?: {
+		/** name of this plot */
+		name: string
+		/** json file path of this plot */
+		file: string
+	}[]
 }
 
 type SampleType = {
@@ -1611,6 +1633,8 @@ type Variant2Samples = GdcApi & {
 	variantkey: string
 	twLst?: Tw[]
 	sunburst_twLst?: Tw[]
+	/** ds-supplied getter */
+	getMutatedSamples?: (q: any, ds: any) => void
 }
 
 type MutationSet = {
@@ -1922,6 +1946,21 @@ export type Mds3 = BaseMds & {
 		data during post-processing */
 		postProcessDtFilter?: boolean
 	}
+	demoJwtInput?: {
+		[role: string]: {
+			datasets?: string[]
+			clientAuthResult?: // sjcares, panMB, SJLife
+			| ClientAuthResult
+				// profile
+				| {
+						[cohort: string]: ClientAuthResult
+				  }
+			// below will be assigned by /demoToken route handler if not specified
+			iat?: number // jwt issued at time, unix time in seconds
+			exp?: number // jwt expiration, unix time in seconds
+			email?: string
+		}
+	}
 	// !!! TODO: improve these type definitions below !!!
 	getHostHeaders?: (q?: any) => any
 	serverconfigFeatures?: any
@@ -1930,6 +1969,12 @@ export type Mds3 = BaseMds & {
 	}
 }
 
+export type ClientAuthResult = {
+	role?: string
+	datasets?: string[]
+	sites?: string[]
+}
+
 export type Mds3WithCohort = Mds3 & {
 	cohort: Cohort
 }