@sjcrh/proteinpaint-types 2.179.0 → 2.180.0

package/package.json

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

package/src/dataset.ts

@@ -1471,6 +1471,8 @@ export type Termdb = {
 	}
 	/** if true, backend is allowed to send sample names to client in charts */
 	displaySampleIds?: (clientAuthResult: any) => boolean
+	/** get samples that match supplied filter */
+	getSamples?: (filter: any, ds: any) => Promise<Set<any>>
 	converSampleIds?: boolean
 	alwaysShowBranchTerms?: boolean
 	minimumSampleAllowed4filter?: number
@@ -1647,6 +1649,8 @@ keep this setting here for reason of:
 	isTermVisible?: (clientAuthResult: any, ids: string) => boolean
 	hiddenIds?: string[]
 	getAdditionalFilter?: (__protected__: any, term: any) => Filter | undefined
+	//Returns allowed values for role-restricted terms. Returns null for no restriction
+	getRestrictedValues?: (clientAuthResult: any, termId: string) => (string | number)[] | null
 	/** collections of dictionary terms (numeric or categorical) that are related and can be used together in some plots */
 	termCollections?: TermCollection[]
 }
@@ -2052,7 +2056,10 @@ export type Mds3 = BaseMds & {
 	// !!! TODO: improve these type definitions below !!!
 	serverconfigFeatures?: any
 	/** a dataset may supply custom URL host and headers to use when making external API requests, such as for GDC */
-	getHostHeaders?: (q?: any) => {
+	getHostHeaders?: (
+		q?: any,
+		overrides?: { [key: string]: string }
+	) => {
 		host: {
 			[apiStyle: string]: string
 		}
@@ -2060,7 +2067,7 @@ export type Mds3 = BaseMds & {
 			[field: string]: string
 		}
 	}
-	/** a dataset may track req.headers based on an abort signal and/or filter0 that was created for the req;
+	/** a dataset may track req.headers based on a req.query, abort signal, and/or filter0;
 	 * this tracking is necessary since the req.headers is not necessarily passed through all to downstream code
 	 * when processing external API-based dataset data, such as for GDC, but req.query.__abortSignal and filter0
 	 * both much more likely to be passed as-is and make it to when `getHostHeaders()` is called */

package/src/routes/termdb.chat2.ts

@@ -40,6 +40,11 @@ export type LlmConfig = {
 	verbose?: boolean
 }
 
+export interface GeneDataTypeResult {
+	gene: string
+	dataType: string
+}
+
 export type ChatResponse = TextResponse | HtmlResponse | PlotResponse
 
 export const ChatPayload: RoutePayload = {
@@ -115,7 +120,7 @@ export type plot_type = {
 	type: 'plot'
 	/** The type of plot to be displayed on the UI.
 	 *  Standard categories are listed; datasets may define additional custom categories. */
-	plot: 'summary' | 'dge' | 'survival' | 'matrix' | 'sampleScatter' | 'hierCluster'
+	plot: 'summary' | 'dge' | 'survival' | 'matrix' | 'sampleScatter' | 'hierCluster' | 'lollipop'
 }
 
 export type resource_type = {
@@ -132,7 +137,7 @@ export type none_type = {
 export type QueryClassification = { type: 'plot' } | { type: 'notplot' }
 
 /** Specific plot type returned by classifyPlotType in plot.ts */
-export type PlotType = 'summary' | 'dge' | 'survival' | 'matrix' | 'samplescatter' | 'hiercluster'
+export type PlotType = 'summary' | 'dge' | 'survival' | 'matrix' | 'samplescatter' | 'hiercluster' | 'lollipop'
 
 export type DEType = {
 	/** Name of group1 which is an array of filter terms */