@sjcrh/proteinpaint-types 2.99.1 → 2.100.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/dataset.ts +8 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sjcrh/proteinpaint-types",
3
- "version": "2.99.1",
3
+ "version": "2.100.0",
4
4
  "type": "module",
5
5
  "description": "Shared type definitions between ProteinPaint server and client code",
6
6
  "main": "src/index.ts",
package/src/dataset.ts CHANGED
@@ -850,9 +850,16 @@ export type SelectCohortEntry = {
850
850
  values: SelectCohortValuesEntry[]
851
851
  /** cohort-related static html shown in about tab */
852
852
  description?: string
853
+ descriptionByCohort?: { [index: string]: string }
853
854
  /** If the description is dependent on the user's role,
854
- define this callback to return description based on auth */
855
+ define this callback to return description based on auth
856
+ returns a static description
857
+ */
855
858
  descriptionByUser?: (auth: any) => string
859
+ /** similar to descriptionByUser but returns an object with one description per cohort,
860
+ about tab will switch description based on user-selected cohort
861
+ */
862
+ descriptionByCohortBasedOnUserRole?: (auth: any) => object
856
863
  /** subtext shown at the very bottom of the cohort/about tab subheader */
857
864
  asterisk?: string
858
865
  //The profile has clearOnChange. The terms used in the plots are not always the same for the profile.