@sjcrh/proteinpaint-types 2.170.26 → 2.170.27

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 +5 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sjcrh/proteinpaint-types",
3
- "version": "2.170.26",
3
+ "version": "2.170.27",
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
@@ -1990,7 +1990,10 @@ export type Mds3 = BaseMds & {
1990
1990
  // !!! TODO: improve these type definitions below !!!
1991
1991
  serverconfigFeatures?: any
1992
1992
  /** a dataset may supply custom URL host and headers to use when making external API requests, such as for GDC */
1993
- getHostHeaders?: (q?: any) => {
1993
+ getHostHeaders?: (
1994
+ q?: any,
1995
+ overrides?: { [key: string]: string }
1996
+ ) => {
1994
1997
  host: {
1995
1998
  [apiStyle: string]: string
1996
1999
  }
@@ -1998,7 +2001,7 @@ export type Mds3 = BaseMds & {
1998
2001
  [field: string]: string
1999
2002
  }
2000
2003
  }
2001
- /** a dataset may track req.headers based on an abort signal and/or filter0 that was created for the req;
2004
+ /** a dataset may track req.headers based on a req.query, abort signal, and/or filter0;
2002
2005
  * this tracking is necessary since the req.headers is not necessarily passed through all to downstream code
2003
2006
  * when processing external API-based dataset data, such as for GDC, but req.query.__abortSignal and filter0
2004
2007
  * both much more likely to be passed as-is and make it to when `getHostHeaders()` is called */