@sjcrh/proteinpaint-types 2.99.0 → 2.99.1-1

package/dist/{chunk-UCG25D2C.js → chunk-75VJBEAQ.js}

@@ -64,7 +64,8 @@ var validSampleWSImagesRequest = (input) => {
 var validSampleWSImagesResponse = (input) => {
   const errors = [];
   const __is = (input2) => {
-    const $io0 = (input3) => Array.isArray(input3.sampleWSImages) && input3.sampleWSImages.every((elem) => "string" === typeof elem);
+    const $io0 = (input3) => Array.isArray(input3.sampleWSImages) && input3.sampleWSImages.every((elem) => "object" === typeof elem && null !== elem && $io1(elem));
+    const $io1 = (input3) => "string" === typeof input3.filename && "string" === typeof input3.metadata;
     return "object" === typeof input2 && null !== input2 && $io0(input2);
   };
   if (false === __is(input)) {
@@ -72,17 +73,30 @@ var validSampleWSImagesResponse = (input) => {
     ((input2, _path, _exceptionable = true) => {
       const $vo0 = (input3, _path2, _exceptionable2 = true) => [(Array.isArray(input3.sampleWSImages) || $report(_exceptionable2, {
         path: _path2 + ".sampleWSImages",
-        expected: "Array<string>",
+        expected: "Array<WSImage>",
         value: input3.sampleWSImages
-      })) && input3.sampleWSImages.map((elem, _index1) => "string" === typeof elem || $report(_exceptionable2, {
+      })) && input3.sampleWSImages.map((elem, _index1) => ("object" === typeof elem && null !== elem || $report(_exceptionable2, {
         path: _path2 + ".sampleWSImages[" + _index1 + "]",
-        expected: "string",
+        expected: "WSImage",
+        value: elem
+      })) && $vo1(elem, _path2 + ".sampleWSImages[" + _index1 + "]", _exceptionable2) || $report(_exceptionable2, {
+        path: _path2 + ".sampleWSImages[" + _index1 + "]",
+        expected: "WSImage",
         value: elem
       })).every((flag) => flag) || $report(_exceptionable2, {
         path: _path2 + ".sampleWSImages",
-        expected: "Array<string>",
+        expected: "Array<WSImage>",
         value: input3.sampleWSImages
       })].every((flag) => flag);
+      const $vo1 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.filename || $report(_exceptionable2, {
+        path: _path2 + ".filename",
+        expected: "string",
+        value: input3.filename
+      }), "string" === typeof input3.metadata || $report(_exceptionable2, {
+        path: _path2 + ".metadata",
+        expected: "string",
+        value: input3.metadata
+      })].every((flag) => flag);
       return ("object" === typeof input2 && null !== input2 || $report(true, {
         path: _path + "",
         expected: "SampleWSImagesResponse",

package/dist/chunk-NBLSSFQV.js

@@ -0,0 +1,91 @@
+import {
+  __toESM,
+  require_lib
+} from "./chunk-Z6B6IQIY.js";
+
+// dist/img.ts
+var import_typia = __toESM(require_lib(), 1);
+
+// src/routes/img.ts
+var imgPayload = {
+  request: {
+    typeId: "imgRequest"
+  },
+  response: {
+    typeId: "imgResponse"
+  }
+};
+
+// dist/img.ts
+var validimgRequest = (input) => {
+  const errors = [];
+  const __is = (input2) => {
+    return "object" === typeof input2 && null !== input2 && "string" === typeof input2.file;
+  };
+  if (false === __is(input)) {
+    const $report = import_typia.createValidate.report(errors);
+    ((input2, _path, _exceptionable = true) => {
+      const $vo0 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.file || $report(_exceptionable2, {
+        path: _path2 + ".file",
+        expected: "string",
+        value: input3.file
+      })].every((flag) => flag);
+      return ("object" === typeof input2 && null !== input2 || $report(true, {
+        path: _path + "",
+        expected: "imgRequest",
+        value: input2
+      })) && $vo0(input2, _path + "", true) || $report(true, {
+        path: _path + "",
+        expected: "imgRequest",
+        value: input2
+      });
+    })(input, "$input", true);
+  }
+  const success = 0 === errors.length;
+  return {
+    success,
+    errors,
+    data: success ? input : void 0
+  };
+};
+var validimgResponse = (input) => {
+  const errors = [];
+  const __is = (input2) => {
+    return "object" === typeof input2 && null !== input2 && ("string" === typeof input2.src && "string" === typeof input2.size);
+  };
+  if (false === __is(input)) {
+    const $report = import_typia.createValidate.report(errors);
+    ((input2, _path, _exceptionable = true) => {
+      const $vo0 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.src || $report(_exceptionable2, {
+        path: _path2 + ".src",
+        expected: "string",
+        value: input3.src
+      }), "string" === typeof input3.size || $report(_exceptionable2, {
+        path: _path2 + ".size",
+        expected: "string",
+        value: input3.size
+      })].every((flag) => flag);
+      return ("object" === typeof input2 && null !== input2 || $report(true, {
+        path: _path + "",
+        expected: "imgResponse",
+        value: input2
+      })) && $vo0(input2, _path + "", true) || $report(true, {
+        path: _path + "",
+        expected: "imgResponse",
+        value: input2
+      });
+    })(input, "$input", true);
+  }
+  const success = 0 === errors.length;
+  return {
+    success,
+    errors,
+    data: success ? input : void 0
+  };
+};
+
+export {
+  imgPayload,
+  validimgRequest,
+  validimgResponse
+};

package/dist/{chunk-XLBSZOMF.js → chunk-W3KUIWKN.js}

@@ -64,16 +64,20 @@ var validWSImagesRequest = (input) => {
 var validWSImagesResponse = (input) => {
   const errors = [];
   const __is = (input2) => {
-    const $io0 = (input3) => (void 0 === input3.sessionId || "string" === typeof input3.sessionId) && (Array.isArray(input3.slide_dimensions) && input3.slide_dimensions.every((elem) => "number" === typeof elem)) && "string" === typeof input3.status;
+    const $io0 = (input3) => (void 0 === input3.wsiSessionId || "string" === typeof input3.wsiSessionId) && (void 0 === input3.browserImageInstanceId || "string" === typeof input3.browserImageInstanceId) && (Array.isArray(input3.slide_dimensions) && input3.slide_dimensions.every((elem) => "number" === typeof elem)) && "string" === typeof input3.status;
     return "object" === typeof input2 && null !== input2 && $io0(input2);
   };
   if (false === __is(input)) {
     const $report = import_typia.createValidate.report(errors);
     ((input2, _path, _exceptionable = true) => {
-      const $vo0 = (input3, _path2, _exceptionable2 = true) => [void 0 === input3.sessionId || "string" === typeof input3.sessionId || $report(_exceptionable2, {
-        path: _path2 + ".sessionId",
+      const $vo0 = (input3, _path2, _exceptionable2 = true) => [void 0 === input3.wsiSessionId || "string" === typeof input3.wsiSessionId || $report(_exceptionable2, {
+        path: _path2 + ".wsiSessionId",
         expected: "(string | undefined)",
-        value: input3.sessionId
+        value: input3.wsiSessionId
+      }), void 0 === input3.browserImageInstanceId || "string" === typeof input3.browserImageInstanceId || $report(_exceptionable2, {
+        path: _path2 + ".browserImageInstanceId",
+        expected: "(string | undefined)",
+        value: input3.browserImageInstanceId
       }), (Array.isArray(input3.slide_dimensions) || $report(_exceptionable2, {
         path: _path2 + ".slide_dimensions",
         expected: "Array<number>",

package/dist/clearwsisession.js

@@ -0,0 +1,88 @@
+import {
+  __toESM,
+  require_lib
+} from "./chunk-Z6B6IQIY.js";
+
+// dist/clearwsisession.ts
+var import_typia = __toESM(require_lib(), 1);
+
+// src/routes/clearwsisessions.ts
+var clearWSImagesSessionsPayload = {
+  request: {
+    typeId: "ClearWSImagesSessionsRequest"
+  },
+  response: {
+    typeId: "ClearWSImagesSessionsResponse"
+  }
+  // examples: []
+};
+
+// dist/clearwsisession.ts
+var validClearWSImagesSessionsRequest = (input) => {
+  const errors = [];
+  const __is = (input2) => {
+    const $io0 = (input3) => Array.isArray(input3.sessions);
+    return "object" === typeof input2 && null !== input2 && $io0(input2);
+  };
+  if (false === __is(input)) {
+    const $report = import_typia.createValidate.report(errors);
+    ((input2, _path, _exceptionable = true) => {
+      const $vo0 = (input3, _path2, _exceptionable2 = true) => [Array.isArray(input3.sessions) || $report(_exceptionable2, {
+        path: _path2 + ".sessions",
+        expected: "Array<any>",
+        value: input3.sessions
+      })].every((flag) => flag);
+      return ("object" === typeof input2 && null !== input2 || $report(true, {
+        path: _path + "",
+        expected: "ClearWSImagesSessionsRequest",
+        value: input2
+      })) && $vo0(input2, _path + "", true) || $report(true, {
+        path: _path + "",
+        expected: "ClearWSImagesSessionsRequest",
+        value: input2
+      });
+    })(input, "$input", true);
+  }
+  const success = 0 === errors.length;
+  return {
+    success,
+    errors,
+    data: success ? input : void 0
+  };
+};
+var validClearWSImagesSessionsResponse = (input) => {
+  const errors = [];
+  const __is = (input2) => {
+    return "object" === typeof input2 && null !== input2 && "string" === typeof input2.message;
+  };
+  if (false === __is(input)) {
+    const $report = import_typia.createValidate.report(errors);
+    ((input2, _path, _exceptionable = true) => {
+      const $vo0 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.message || $report(_exceptionable2, {
+        path: _path2 + ".message",
+        expected: "string",
+        value: input3.message
+      })].every((flag) => flag);
+      return ("object" === typeof input2 && null !== input2 || $report(true, {
+        path: _path + "",
+        expected: "ClearWSImagesSessionsResponse",
+        value: input2
+      })) && $vo0(input2, _path + "", true) || $report(true, {
+        path: _path + "",
+        expected: "ClearWSImagesSessionsResponse",
+        value: input2
+      });
+    })(input, "$input", true);
+  }
+  const success = 0 === errors.length;
+  return {
+    success,
+    errors,
+    data: success ? input : void 0
+  };
+};
+export {
+  clearWSImagesSessionsPayload,
+  validClearWSImagesSessionsRequest,
+  validClearWSImagesSessionsResponse
+};

package/dist/img.js

@@ -0,0 +1,11 @@
+import {
+  imgPayload,
+  validimgRequest,
+  validimgResponse
+} from "./chunk-NBLSSFQV.js";
+import "./chunk-Z6B6IQIY.js";
+export {
+  imgPayload,
+  validimgRequest,
+  validimgResponse
+};

package/dist/index.js

@@ -1,3 +1,13 @@
+import {
+  termChildrenPayload,
+  validTermChildrenRequest,
+  validTermChildrenResponse
+} from "./chunk-5RZYB4M4.js";
+import {
+  termsByIdsPayload,
+  validTermsByIdsRequest,
+  validTermsByIdsResponse
+} from "./chunk-QV7KKZV4.js";
 import {
   termdbTopTermsByTypePayload,
   validTermdbTopTermsByTypeRequest,
@@ -22,7 +32,17 @@ import {
   validWSImagesRequest,
   validWSImagesResponse,
   wsImagesPayload
-} from "./chunk-XLBSZOMF.js";
+} from "./chunk-W3KUIWKN.js";
+import {
+  numericCategoriesPayload,
+  validNumericCategoriesRequest,
+  validNumericCategoriesResponse
+} from "./chunk-JDJZ35H6.js";
+import {
+  percentilePayload,
+  validPercentileRequest,
+  validPercentileResponse
+} from "./chunk-IORCECK2.js";
 import {
   rootTermPayload,
   validRootTermRequest,
@@ -54,15 +74,15 @@ import {
   validTermdbSingleCellSamplesResponse
 } from "./chunk-FZ6QOTGM.js";
 import {
-  termChildrenPayload,
-  validTermChildrenRequest,
-  validTermChildrenResponse
-} from "./chunk-5RZYB4M4.js";
+  snpPayload,
+  validSnpRequest,
+  validSnpResponse
+} from "./chunk-XJCQEOPB.js";
 import {
-  termsByIdsPayload,
-  validTermsByIdsRequest,
-  validTermsByIdsResponse
-} from "./chunk-QV7KKZV4.js";
+  diffExpPayload,
+  validDERequest,
+  validDEResponse
+} from "./chunk-Z2WFGV6V.js";
 import {
   boxplotPayload,
   validBoxPlotRequest,
@@ -94,20 +114,20 @@ import {
   validDescrStatsResponse
 } from "./chunk-HQDTWY25.js";
 import {
-  numericCategoriesPayload,
-  validNumericCategoriesRequest,
-  validNumericCategoriesResponse
-} from "./chunk-JDJZ35H6.js";
-import {
-  percentilePayload,
-  validPercentileRequest,
-  validPercentileResponse
-} from "./chunk-IORCECK2.js";
+  hicGenomePayload,
+  validHicGenomeRequest,
+  validHicGenomeResponse
+} from "./chunk-W3QYIXXF.js";
 import {
   hicstatPayload,
   validHicstatRequest,
   validHicstatResponse
 } from "./chunk-QX7QLUKY.js";
+import {
+  imgPayload,
+  validimgRequest,
+  validimgResponse
+} from "./chunk-NBLSSFQV.js";
 import {
   isoformlstPayload,
   validIsoformLstRequest,
@@ -127,17 +147,12 @@ import {
   sampleWSImagesPayload,
   validSampleWSImagesRequest,
   validSampleWSImagesResponse
-} from "./chunk-UCG25D2C.js";
-import {
-  snpPayload,
-  validSnpRequest,
-  validSnpResponse
-} from "./chunk-XJCQEOPB.js";
+} from "./chunk-75VJBEAQ.js";
 import {
-  diffExpPayload,
-  validDERequest,
-  validDEResponse
-} from "./chunk-Z2WFGV6V.js";
+  gdcMafPayload,
+  validGdcMafRequest,
+  validGdcMafResponse
+} from "./chunk-CETMA2FU.js";
 import {
   GdcMafPayload,
   validGdcMafBuildRequest,
@@ -173,11 +188,6 @@ import {
   validHicdataRequest,
   validHicdataResponse
 } from "./chunk-5JWTIWVB.js";
-import {
-  hicGenomePayload,
-  validHicGenomeRequest,
-  validHicGenomeResponse
-} from "./chunk-W3QYIXXF.js";
 import {
   brainImagingPayload,
   validBrainImagingRequest,
@@ -213,11 +223,6 @@ import {
   validDZImagesRequest,
   validDZImagesResponse
 } from "./chunk-SDOWCOGK.js";
-import {
-  gdcMafPayload,
-  validGdcMafRequest,
-  validGdcMafResponse
-} from "./chunk-CETMA2FU.js";
 import "./chunk-Z6B6IQIY.js";
 export {
   CorrelationVolcanoPayload,
@@ -240,6 +245,7 @@ export {
   hicGenomePayload,
   hicdataPayload,
   hicstatPayload,
+  imgPayload,
   isoformlstPayload,
   ntseqPayload,
   numericCategoriesPayload,
@@ -350,6 +356,8 @@ export {
   validViolinResponse,
   validWSImagesRequest,
   validWSImagesResponse,
+  validimgRequest,
+  validimgResponse,
   violinPayload,
   wsImagesPayload
 };

package/dist/samplewsimages.js

@@ -2,7 +2,7 @@ import {
   sampleWSImagesPayload,
   validSampleWSImagesRequest,
   validSampleWSImagesResponse
-} from "./chunk-UCG25D2C.js";
+} from "./chunk-75VJBEAQ.js";
 import "./chunk-Z6B6IQIY.js";
 export {
   sampleWSImagesPayload,

package/dist/wsimages.js

@@ -2,7 +2,7 @@ import {
   validWSImagesRequest,
   validWSImagesResponse,
   wsImagesPayload
-} from "./chunk-XLBSZOMF.js";
+} from "./chunk-W3KUIWKN.js";
 import "./chunk-Z6B6IQIY.js";
 export {
   validWSImagesRequest,

package/package.json

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

package/src/dataset.ts

@@ -694,6 +694,17 @@ also, sampleView uses this to determine if to invoke the sc plot for a sample
 	geneExpression?: SingleCellGeneExpressionGdc | SingleCellGeneExpressionNative
 	/** Precomputed top differentialy expressed genes for a cell cluster, against rest of cells */
 	DEgenes?: SingleCellDEgeneGdc
+	/** supplies per-sample images. will create a new tab on the ui. one image per sample */
+	images?: SCImages
+}
+
+type SCImages = {
+	/** folder where the per-sample image files are stored, as "SCImages/<folder>/<sample>/<fileName>" */
+	folder: string
+	/** see above */
+	fileName: string
+	/**Used to name the image tab in the single cell plot */
+	label: string
 }
 
 type LdQuery = {
@@ -818,9 +829,9 @@ export type WSImages = {
 	// type of the image, e.g. H&E
 	type: string
 	// path to the folder where sample images are stored
-	imageBySampleFolder: string
-	// TODO extend to support multiple sources
-	//sources?: []
+	imageBySampleFolder?: string
+
+	sources?: string
 }
 
 /*** types supporting Termdb ***/

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './routes/routeApi.ts'
 export * from './routes/brainImaging.ts'
 export * from './routes/brainImagingSamples.ts'
 export * from './routes/burden.ts'
+export * from './routes/clearwsisessions.ts'
 export * from './routes/correlationVolcano.ts'
 export * from './routes/dataset.ts'
 export * from './routes/dsdata.ts'
@@ -41,6 +42,7 @@ export * from './routes/termdb.percentile.ts'
 export * from './routes/termdb.rootterm.ts'
 export * from './routes/termdb.termchildren.ts'
 export * from './routes/termdb.sampleImages.ts'
+export * from './routes/img.ts'
 export * from './routes/termdb.singlecellData.ts'
 export * from './routes/termdb.singlecellDEgenes.ts'
 export * from './routes/termdb.singlecellSamples.ts'

package/src/routes/clearwsisessions.ts

@@ -0,0 +1,19 @@
+import type { RoutePayload } from './routeApi.ts'
+
+export type ClearWSImagesSessionsRequest = {
+	sessions: Array<any>
+}
+
+export type ClearWSImagesSessionsResponse = {
+	message: string
+}
+
+export const clearWSImagesSessionsPayload: RoutePayload = {
+	request: {
+		typeId: 'ClearWSImagesSessionsRequest'
+	},
+	response: {
+		typeId: 'ClearWSImagesSessionsResponse'
+	}
+	// examples: []
+}

package/src/routes/img.ts

@@ -0,0 +1,23 @@
+import type { RoutePayload } from './routeApi.js'
+
+export type imgRequest = {
+	file: string
+}
+
+export type SrcImage = {
+	src: any
+}
+
+export type imgResponse = {
+	src: string
+	size: string
+}
+
+export const imgPayload: RoutePayload = {
+	request: {
+		typeId: 'imgRequest'
+	},
+	response: {
+		typeId: 'imgResponse'
+	}
+}

package/src/routes/routeApi.ts

@@ -3,6 +3,8 @@ export type RouteApi = {
 	methods: {
 		get?: RoutePayload
 		post?: RoutePayload
+		put?: RoutePayload
+		delete?: RoutePayload
 	}
 }
 

package/src/routes/samplewsimages.ts

@@ -8,7 +8,7 @@ export type SampleWSImagesRequest = {
 }
 
 export type SampleWSImagesResponse = {
-	sampleWSImages: string[]
+	sampleWSImages: WSImage[]
 }
 
 export type WSImage = {

package/src/routes/wsimages.ts

@@ -8,7 +8,11 @@ export type WSImagesRequest = {
 }
 
 export type WSImagesResponse = {
-	sessionId?: string
+	// TileServer image session id
+	wsiSessionId?: string
+	// Identifier for the image instance displayed in the browser
+	// In case the same image is displayed in multiple browser windows, a new id is generated
+	browserImageInstanceId?: string
 	slide_dimensions: number[]
 	status: string
 }