@sjcrh/proteinpaint-types 2.99.1 → 2.99.2-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 +7 -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.99.2-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
@@ -851,8 +851,14 @@ export type SelectCohortEntry = {
851
851
  /** cohort-related static html shown in about tab */
852
852
  description?: string
853
853
  /** If the description is dependent on the user's role,
854
- define this callback to return description based on auth */
854
+ define this callback to return description based on auth
855
+ returns a static description
856
+ */
855
857
  descriptionByUser?: (auth: any) => string
858
+ /** similar to descriptionByUser but returns an object with one description per cohort,
859
+ about tab will switch description based on user-selected cohort
860
+ */
861
+ descriptionByCohortBasedOnUserRole?: (auth: any) => object
856
862
  /** subtext shown at the very bottom of the cohort/about tab subheader */
857
863
  asterisk?: string
858
864
  //The profile has clearOnChange. The terms used in the plots are not always the same for the profile.