@sjcrh/proteinpaint-types 2.99.1-2 → 2.99.2-0

package/package.json

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

package/src/dataset.ts

@@ -580,31 +580,23 @@ export type SingleCellGeneExpressionGdc = {
 	src: 'gdcapi'
 }
 
-export type SingleCellSamplesNative = {
-	src: 'native'
-	/** kept to prevent tsc err */
-	firstColumnName?: string
-	/** any columns to be added to sample table. each is a term id */
-	sampleColumns?: { termid: string }[]
-	/** used on client but not on ds */
-	experimentColumns?: { label: string }[]
-	get?: (q: any) => any
-}
-
-export type SingleCellSamplesGdc = {
-	src: 'gdcapi'
+export type SingleCellSamples = {
 	/** if missing refer to the samples as 'sample', this provides override e.g. 'case' */
 	/** logic to decide sample table columns (the one shown on singlecell app ui, displaying a table of samples with sc data)
-a sample table will always have a sample column, to show sample.sample value
-firstColumnName allow to change name of 1st column from "Sample" to different, e.g. "Case" for gdc
-the other two properties allow to declare additional columns to be shown in table, that are for display only
-when sample.experiments[] are used, a last column of experiment id will be auto added
-*/
+	a sample table will always have a sample column, to show sample.sample value
+	firstColumnName allow to change name of 1st column from "Sample" to different, e.g. "Case" for gdc
+	the other two properties allow to declare additional columns to be shown in table, that are for display only
+	when sample.experiments[] are used, a last column of experiment id will be auto added
+	*/
 	firstColumnName?: string
-	/** same as SingleCellSamplesNative */
+	/** any columns to be added to sample table. each is a term id */
 	sampleColumns?: { termid: string }[]
 	/** used on client but not on ds */
 	experimentColumns?: { label: string }[]
+	/** getter function to return list of samples with single-cell data
+	is either ds-supplied, to enclose ds-specific query details (gdc)
+	or is missing, to be added at launch with built-in logic (samples are found by looking through singleCell.data.plots[].folder)
+	*/
 	get?: (q: any) => any
 }
 
@@ -683,10 +675,10 @@ export type SingleCellDataNative = {
 
 export type SingleCellQuery = {
 	/** methods to identify samples with singlecell data,
-this data allows client-side to display a table with these samples for user to choose from
-also, sampleView uses this to determine if to invoke the sc plot for a sample
-*/
-	samples: SingleCellSamplesGdc | SingleCellSamplesNative
+	this data allows client-side to display a table with these samples for user to choose from
+	also, sampleView uses this to determine if to invoke the sc plot for a sample
+	*/
+	samples: SingleCellSamples
 	/** defines tsne/umap type of clustering maps for each sample
 	 */
 	data: SingleCellDataGdc | SingleCellDataNative
@@ -859,8 +851,14 @@ export type SelectCohortEntry = {
 	/** cohort-related static html shown in about tab */
 	description?: string
 	/** If the description is dependent on the user's role, 
-	define this callback to return description based on auth */
+	define this callback to return description based on auth
+	returns a static description
+	*/
 	descriptionByUser?: (auth: any) => string
+	/** similar to descriptionByUser but returns an object with one description per cohort,
+	about tab will switch description based on user-selected cohort
+	*/
+	descriptionByCohortBasedOnUserRole?: (auth: any) => object
 	/** subtext shown at the very bottom of the cohort/about tab subheader */
 	asterisk?: string
 	//The profile has clearOnChange. The terms used in the plots are not always the same for the profile.