@sjcrh/proteinpaint-types 2.171.0 → 2.172.0

package/dist/chunk-JKELINOM.js

@@ -0,0 +1,179 @@
+import {
+  __toESM,
+  require_lib
+} from "./chunk-YNHC5SXO.js";
+
+// dist/termdb.runChart.ts
+var import_typia = __toESM(require_lib(), 1);
+
+// src/routes/termdb.runChart.ts
+var runChartPayload = {
+  request: {
+    typeId: "RunChartRequest"
+  },
+  response: {
+    typeId: "RunChartResponse"
+  }
+};
+
+// dist/termdb.runChart.ts
+var validRunChartRequest = (input) => {
+  const errors = [];
+  const __is = (input2) => {
+    const $io0 = (input3) => "string" === typeof input3.genome && "string" === typeof input3.dslabel && ("object" === typeof input3.term && null !== input3.term && "string" === typeof input3.term.id) && ("object" === typeof input3.term2 && null !== input3.term2 && "string" === typeof input3.term2.id) && ("median" === input3.aggregation || "mean" === input3.aggregation || "count" === input3.aggregation) && true && true;
+    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) => ["string" === typeof input3.genome || $report(_exceptionable2, {
+        path: _path2 + ".genome",
+        expected: "string",
+        value: input3.genome
+      }), "string" === typeof input3.dslabel || $report(_exceptionable2, {
+        path: _path2 + ".dslabel",
+        expected: "string",
+        value: input3.dslabel
+      }), ("object" === typeof input3.term && null !== input3.term || $report(_exceptionable2, {
+        path: _path2 + ".term",
+        expected: "__type",
+        value: input3.term
+      })) && $vo1(input3.term, _path2 + ".term", _exceptionable2) || $report(_exceptionable2, {
+        path: _path2 + ".term",
+        expected: "__type",
+        value: input3.term
+      }), ("object" === typeof input3.term2 && null !== input3.term2 || $report(_exceptionable2, {
+        path: _path2 + ".term2",
+        expected: "__type.o1",
+        value: input3.term2
+      })) && $vo2(input3.term2, _path2 + ".term2", _exceptionable2) || $report(_exceptionable2, {
+        path: _path2 + ".term2",
+        expected: "__type.o1",
+        value: input3.term2
+      }), "median" === input3.aggregation || "mean" === input3.aggregation || "count" === input3.aggregation || $report(_exceptionable2, {
+        path: _path2 + ".aggregation",
+        expected: '("count" | "mean" | "median")',
+        value: input3.aggregation
+      }), true, true].every((flag) => flag);
+      const $vo1 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.id || $report(_exceptionable2, {
+        path: _path2 + ".id",
+        expected: "string",
+        value: input3.id
+      })].every((flag) => flag);
+      const $vo2 = (input3, _path2, _exceptionable2 = true) => ["string" === typeof input3.id || $report(_exceptionable2, {
+        path: _path2 + ".id",
+        expected: "string",
+        value: input3.id
+      })].every((flag) => flag);
+      return ("object" === typeof input2 && null !== input2 || $report(true, {
+        path: _path + "",
+        expected: "RunChartRequest",
+        value: input2
+      })) && $vo0(input2, _path + "", true) || $report(true, {
+        path: _path + "",
+        expected: "RunChartRequest",
+        value: input2
+      });
+    })(input, "$input", true);
+  }
+  const success = 0 === errors.length;
+  return {
+    success,
+    errors,
+    data: success ? input : void 0
+  };
+};
+var validRunChartResponse = (input) => {
+  const errors = [];
+  const __is = (input2) => {
+    const $io0 = (input3) => ("ok" === input3.status || "error" === input3.status) && (Array.isArray(input3.series) && input3.series.every((elem) => "object" === typeof elem && null !== elem && $io1(elem)));
+    const $io1 = (input3) => "number" === typeof input3.median && (Array.isArray(input3.points) && input3.points.every((elem) => "object" === typeof elem && null !== elem && $io2(elem)));
+    const $io2 = (input3) => "number" === typeof input3.x && "string" === typeof input3.xName && "number" === typeof input3.y && "number" === typeof input3.sampleCount;
+    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) => ["ok" === input3.status || "error" === input3.status || $report(_exceptionable2, {
+        path: _path2 + ".status",
+        expected: '("error" | "ok")',
+        value: input3.status
+      }), (Array.isArray(input3.series) || $report(_exceptionable2, {
+        path: _path2 + ".series",
+        expected: "Array<__type>",
+        value: input3.series
+      })) && input3.series.map((elem, _index1) => ("object" === typeof elem && null !== elem || $report(_exceptionable2, {
+        path: _path2 + ".series[" + _index1 + "]",
+        expected: "__type",
+        value: elem
+      })) && $vo1(elem, _path2 + ".series[" + _index1 + "]", _exceptionable2) || $report(_exceptionable2, {
+        path: _path2 + ".series[" + _index1 + "]",
+        expected: "__type",
+        value: elem
+      })).every((flag) => flag) || $report(_exceptionable2, {
+        path: _path2 + ".series",
+        expected: "Array<__type>",
+        value: input3.series
+      })].every((flag) => flag);
+      const $vo1 = (input3, _path2, _exceptionable2 = true) => ["number" === typeof input3.median || $report(_exceptionable2, {
+        path: _path2 + ".median",
+        expected: "number",
+        value: input3.median
+      }), (Array.isArray(input3.points) || $report(_exceptionable2, {
+        path: _path2 + ".points",
+        expected: "Array<Point>",
+        value: input3.points
+      })) && input3.points.map((elem, _index2) => ("object" === typeof elem && null !== elem || $report(_exceptionable2, {
+        path: _path2 + ".points[" + _index2 + "]",
+        expected: "Point",
+        value: elem
+      })) && $vo2(elem, _path2 + ".points[" + _index2 + "]", _exceptionable2) || $report(_exceptionable2, {
+        path: _path2 + ".points[" + _index2 + "]",
+        expected: "Point",
+        value: elem
+      })).every((flag) => flag) || $report(_exceptionable2, {
+        path: _path2 + ".points",
+        expected: "Array<Point>",
+        value: input3.points
+      })].every((flag) => flag);
+      const $vo2 = (input3, _path2, _exceptionable2 = true) => ["number" === typeof input3.x || $report(_exceptionable2, {
+        path: _path2 + ".x",
+        expected: "number",
+        value: input3.x
+      }), "string" === typeof input3.xName || $report(_exceptionable2, {
+        path: _path2 + ".xName",
+        expected: "string",
+        value: input3.xName
+      }), "number" === typeof input3.y || $report(_exceptionable2, {
+        path: _path2 + ".y",
+        expected: "number",
+        value: input3.y
+      }), "number" === typeof input3.sampleCount || $report(_exceptionable2, {
+        path: _path2 + ".sampleCount",
+        expected: "number",
+        value: input3.sampleCount
+      })].every((flag) => flag);
+      return ("object" === typeof input2 && null !== input2 || $report(true, {
+        path: _path + "",
+        expected: "RunChartResponse",
+        value: input2
+      })) && $vo0(input2, _path + "", true) || $report(true, {
+        path: _path + "",
+        expected: "RunChartResponse",
+        value: input2
+      });
+    })(input, "$input", true);
+  }
+  const success = 0 === errors.length;
+  return {
+    success,
+    errors,
+    data: success ? input : void 0
+  };
+};
+
+export {
+  runChartPayload,
+  validRunChartRequest,
+  validRunChartResponse
+};

package/dist/index.js

@@ -1,3 +1,8 @@
+import {
+  termsByIdsPayload,
+  validTermsByIdsRequest,
+  validTermsByIdsResponse
+} from "./chunk-CUU7POGC.js";
 import {
   topMutatedGenePayload,
   validtopMutatedGeneRequest,
@@ -33,6 +38,11 @@ import {
   validWSISamplesResponse,
   wsiSamplesPayload
 } from "./chunk-2744ACBX.js";
+import {
+  runChartPayload,
+  validRunChartRequest,
+  validRunChartResponse
+} from "./chunk-JKELINOM.js";
 import {
   termdbSampleImagesPayload,
   validTermdbSampleImagesRequest,
@@ -68,11 +78,6 @@ import {
   validTermChildrenRequest,
   validTermChildrenResponse
 } from "./chunk-P25WDNMD.js";
-import {
-  termsByIdsPayload,
-  validTermsByIdsRequest,
-  validTermsByIdsResponse
-} from "./chunk-CUU7POGC.js";
 import {
   termdbCohortsPayload,
   validTermdbCohortsRequest,
@@ -349,6 +354,7 @@ export {
   pdomainPayload,
   percentilePayload,
   rootTermPayload,
+  runChartPayload,
   runGRIN2Payload,
   sampleWSImagesPayload,
   saveWSIAnnotationPayload,
@@ -443,6 +449,8 @@ export {
   validProfileScoresResponse,
   validRootTermRequest,
   validRootTermResponse,
+  validRunChartRequest,
+  validRunChartResponse,
   validRunGRIN2Request,
   validRunGRIN2Response,
   validSampleWSImagesRequest,

package/dist/termdb.runChart.js

@@ -0,0 +1,11 @@
+import {
+  runChartPayload,
+  validRunChartRequest,
+  validRunChartResponse
+} from "./chunk-JKELINOM.js";
+import "./chunk-YNHC5SXO.js";
+export {
+  runChartPayload,
+  validRunChartRequest,
+  validRunChartResponse
+};

package/package.json

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

package/src/index.ts

@@ -47,6 +47,7 @@ export * from './routes/termdb.DE.ts'
 export * from './routes/termdb.descrstats.ts'
 export * from './routes/termdb.numericcategories.ts'
 export * from './routes/termdb.percentile.ts'
+export * from './routes/termdb.runChart.ts'
 export * from './routes/termdb.rootterm.ts'
 export * from './routes/termdb.termchildren.ts'
 export * from './routes/termdb.sampleImages.ts'

package/src/routes/routeApi.ts

@@ -15,11 +15,15 @@ export type RoutePayload = {
 	/** if examples are not provided, will not test */
 	examples?: PayloadExample[]
 }
-
 export type RouteMethod = {
 	typeId: string
 	checker?: any
 }
+/* later replace actual values */
+export type Point = {
+	x: string
+	y: string | number
+}
 
 type RouteInitArg = {
 	app: any

package/src/routes/termdb.runChart.ts

@@ -0,0 +1,47 @@
+import type { RoutePayload } from './routeApi.ts'
+
+export type RunChartRequest = {
+	genome: string
+	dslabel: string
+	/** date term for x axis */
+	term: {
+		id: string
+	}
+	/** timeline/duration term for y axis */
+	term2: {
+		id: string
+	}
+	aggregation: 'mean' | 'median' | 'count'
+	filter?: any
+	__protected__?: any // auth token for accessing protected data
+}
+
+export type RunChartResponse = {
+	status: 'ok' | 'error'
+	/** each series is one curve, with a median. a runchart may show 1 or multiple curves */
+	series: {
+		/** calculated Y median value for this curve */
+		median: number
+		points: Point[]
+	}[]
+}
+
+type Point = {
+	/** decimal year, e.g. 2024.21321321 */
+	x: number
+	/** text of human-readable x value, e.g. "Jan 2024" which may be by the months, depends on dataset customization */
+	xName: string
+	/** timeline, e.g. number of days */
+	y: number
+	/** number of samples with this timeline at this time point */
+	sampleCount: number
+}
+
+export const runChartPayload: RoutePayload = {
+	request: {
+		typeId: 'RunChartRequest'
+	},
+	response: {
+		typeId: 'RunChartResponse'
+	}
+}