Add type to schemas

haoadoreorange · haoadoresorange · commit 9c795889cff9 · 2021-12-14T23:46:08.000-05:00
Signed-off-by: Quoc-Hao Tran &lt;quoc-hao.tran@polymtl.ca&gt;
diff --git a/tsp-typescript-client/package.json b/tsp-typescript-client/package.json
@@ -23,7 +23,7 @@
   "dependencies": {
     "node-fetch": "^2.5.0",
     "rimraf": "latest",
-    "when-json-met-bigint": "^0.21.0"
+    "when-json-met-bigint": "^0.25.0"
   },
   "scripts": {
     "prepare": "yarn run clean && yarn run build",
diff --git a/tsp-typescript-client/src/models/annotation.ts b/tsp-typescript-client/src/models/annotation.ts
@@ -11,7 +11,7 @@ export interface AnnotationCategoriesModel {
     annotationCategories: string[];
 }
 
-export const AnnotationSchema: Schema = {
+export const AnnotationSchema: Schema<AnnotationModel> = {
     annotations: {
         [Symbol.for(`any`)]: [{
             duration: bigint,
diff --git a/tsp-typescript-client/src/models/bookmark.ts b/tsp-typescript-client/src/models/bookmark.ts
@@ -1,7 +1,7 @@
 import { Schema } from 'when-json-met-bigint';
 import { bigint } from '../protocol/serialization';
 
-export const BookmarkSchema: Schema = {
+export const BookmarkSchema: Schema<Bookmark> = {
     endTime: bigint,
     startTime: bigint,
 };
diff --git a/tsp-typescript-client/src/models/entry.ts b/tsp-typescript-client/src/models/entry.ts
@@ -2,7 +2,7 @@ import { Schema } from 'when-json-met-bigint';
 import { assertNumber } from '../protocol/serialization';
 import { OutputElementStyle } from './styles';
 
-export const EntrySchema: Schema = {
+export const EntrySchema: Schema<Entry> = {
     id: assertNumber,
     parentId: assertNumber,
 };
@@ -52,7 +52,7 @@ export interface EntryHeader {
     tooltip: string
 }
 
-export const EntryModelSchema = (schema: Schema): Schema => ({ entries: [schema] });
+export const EntryModelSchema = <T extends Entry>(schema: Schema<T>): Schema<EntryModel<T>> => ({ entries: [schema] });
 
 /**
  * Entry model that will be returned by the server
diff --git a/tsp-typescript-client/src/models/experiment.ts b/tsp-typescript-client/src/models/experiment.ts
@@ -2,7 +2,7 @@ import { Schema } from 'when-json-met-bigint';
 import { assertNumber, bigint } from '../protocol/serialization';
 import { TraceSchema, Trace } from './trace';
 
-export const ExperimentSchema: Schema = {
+export const ExperimentSchema: Schema<Experiment> = {
     end: bigint,
     nbEvents: assertNumber,
     start: bigint,
diff --git a/tsp-typescript-client/src/models/output-descriptor.ts b/tsp-typescript-client/src/models/output-descriptor.ts
@@ -1,7 +1,7 @@
 import { Schema } from 'when-json-met-bigint';
 import { bigint } from '../protocol/serialization';
 
-export const OutputDescriptorSchema: Schema = {
+export const OutputDescriptorSchema: Schema<OutputDescriptor> = {
     end: bigint,
     start: bigint,
 };
diff --git a/tsp-typescript-client/src/models/response/responses.ts b/tsp-typescript-client/src/models/response/responses.ts
@@ -24,7 +24,7 @@ export enum ResponseStatus {
     CANCELLED = 'CANCELLED'
 }
 
-export const GenericResponseSchema = (schema: Schema): Schema => ({ model: schema });
+export const GenericResponseSchema = <T>(schema: Schema<T>): Schema<GenericResponse<T>> => ({ model: schema });
 
 /**
  * Generic response that contains a model
diff --git a/tsp-typescript-client/src/models/table.ts b/tsp-typescript-client/src/models/table.ts
@@ -1,7 +1,7 @@
 import { Schema } from 'when-json-met-bigint';
 import { assertNumber } from '../protocol/serialization';
 
-export const ColumnHeaderEntrySchema: Schema = {
+export const ColumnHeaderEntrySchema: Schema<ColumnHeaderEntry> = {
     id: assertNumber,
 };
 
@@ -30,7 +30,7 @@ export interface ColumnHeaderEntry {
     type: string;
 }
 
-export const CellSchema: Schema = {
+export const CellSchema: Schema<Cell> = {
     tags: assertNumber,
 };
 
@@ -49,7 +49,7 @@ export interface Cell {
     tags?: number;
 }
 
-export const LineSchema = {
+export const LineSchema: Schema<Line> = {
     cells: [CellSchema],
     index: assertNumber,
     tags: assertNumber,
@@ -75,7 +75,7 @@ export interface Line {
     tags?: number;
 }
 
-export const TableModelSchema = {
+export const TableModelSchema: Schema<TableModel> = {
     columnIds: [assertNumber],
     lines: [LineSchema],
     lowIndex: assertNumber,
diff --git a/tsp-typescript-client/src/models/timegraph.ts b/tsp-typescript-client/src/models/timegraph.ts
@@ -3,7 +3,7 @@ import { assertNumber, bigint } from '../protocol/serialization';
 import { Entry } from './entry';
 import { OutputElementStyle } from './styles';
 
-export const TimeGraphEntrySchema: Schema = {
+export const TimeGraphEntrySchema: Schema<TimeGraphEntry> = {
     end: bigint,
     id: assertNumber,
     parentId: assertNumber,
@@ -25,7 +25,7 @@ export interface TimeGraphEntry extends Entry {
     end: bigint;
 }
 
-const TimeGraphStateSchema: Schema = {
+const TimeGraphStateSchema: Schema<TimeGraphState> = {
     end: bigint,
     start: bigint,
     tags: assertNumber,
@@ -61,7 +61,7 @@ export interface TimeGraphState {
     style?: OutputElementStyle;
 }
 
-export const TimeGraphRowSchema: Schema = {
+export const TimeGraphRowSchema: Schema<TimeGraphRow> = {
     entryId: assertNumber,
     states: [TimeGraphStateSchema],
 };
@@ -81,7 +81,7 @@ export interface TimeGraphRow {
     states: TimeGraphState[];
 }
 
-export const TimeGraphModelSchema: Schema = {
+export const TimeGraphModelSchema: Schema<TimeGraphModel> = {
     rows: [TimeGraphRowSchema],
 };
 
@@ -92,7 +92,7 @@ export interface TimeGraphModel {
     rows: TimeGraphRow[];
 }
 
-export const TimeGraphArrowSchema: Schema = {
+export const TimeGraphArrowSchema: Schema<TimeGraphArrow> = {
     end: bigint,
     sourceId: assertNumber,
     start: bigint,
diff --git a/tsp-typescript-client/src/models/trace.ts b/tsp-typescript-client/src/models/trace.ts
@@ -1,7 +1,7 @@
 import { Schema } from 'when-json-met-bigint';
 import { assertNumber, bigint } from '../protocol/serialization';
 
-export const TraceSchema: Schema = {
+export const TraceSchema: Schema<Trace> = {
     end: bigint,
     nbEvents: assertNumber,
     start: bigint,
diff --git a/tsp-typescript-client/src/models/xy.ts b/tsp-typescript-client/src/models/xy.ts
@@ -1,7 +1,7 @@
 import { Schema } from 'when-json-met-bigint';
 import { assertNumber, number } from '../protocol/serialization';
 
-export const XYSeriesSchema: Schema = {
+export const XYSeriesSchema: Schema<XYSeries> = {
     seriesId: assertNumber,
     xValues: [number], // lossy conversion if too big
     yValues: [assertNumber],
@@ -48,7 +48,7 @@ export interface XYSeries {
     tags?: number[];
 }
 
-export const XYModelSchema: Schema = {
+export const XYModelSchema: Schema<XYModel> = {
     series: [XYSeriesSchema],
 };
 
diff --git a/tsp-typescript-client/src/protocol/serialization.ts b/tsp-typescript-client/src/protocol/serialization.ts
@@ -5,7 +5,7 @@ export const number = `number`;
 /**
  * Throw if `input` is not a `number`.
  */
-export const assertNumber: Schema = (num) => {
+export const assertNumber: Schema<number> = (num) => {
     if (typeof num === bigint) {
         throw new TypeError(`Expected ${num} to be ${number}, found ${bigint}!`);
     }
diff --git a/tsp-typescript-client/src/protocol/tsp-client.ts b/tsp-typescript-client/src/protocol/tsp-client.ts
@@ -164,7 +164,6 @@ export class TspClient {
         parameters: Query,
     ): Promise<TspClientResponse<GenericResponse<XYModel>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/XY/' + outputID + '/xy';
-        console.log(JSON.stringify(GenericResponseSchema(XYModelSchema))); 
         return RestClient.post(url, parameters, GenericResponseSchema(XYModelSchema));
     }
 
diff --git a/yarn.lock b/yarn.lock
@@ -6277,10 +6277,10 @@ whatwg-url@^8.0.0, whatwg-url@^8.4.0, whatwg-url@^8.5.0:
     tr46 "^2.1.0"
     webidl-conversions "^6.1.0"
 
-when-json-met-bigint@^0.21.0:
-  version "0.21.0"
-  resolved "https://registry.yarnpkg.com/when-json-met-bigint/-/when-json-met-bigint-0.21.0.tgz#cf2d1e78690a84767b073d8c05f2a419df7117b7"
-  integrity sha512-RZwbeIBslSCWR7oXT03mV2ojwy5A+iO7k55mNsmqrsWnvUqJtmimv4M9wULd8I9jHZj7HnYlW1ZRaQzj2FRjFg==
+when-json-met-bigint@^0.25.0:
+  version "0.25.0"
+  resolved "https://registry.yarnpkg.com/when-json-met-bigint/-/when-json-met-bigint-0.25.0.tgz#15b8a8048ee6e5fcf205484d5c73a0945680d943"
+  integrity sha512-SJqMCy5tXFiO+HH6g6DewyOEQpCRFtLw10ckhh/UlI3xFPvEEuhBkXU6gnxXA4xSrerKKgZpGbXzGl0FTb4ROg==
 
 which-boxed-primitive@^1.0.2:
   version "1.0.2"

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export interface AnnotationCategoriesModel {`
`11`	`11`	`annotationCategories: string[];`
`12`	`12`	`}`
`13`	`13`
`14`		`-export const AnnotationSchema: Schema = {`
	`14`	`+export const AnnotationSchema: Schema<AnnotationModel> = {`
`15`	`15`	`annotations: {`
`16`	`16`	[Symbol.for(`any`)]: [{
`17`	`17`	`duration: bigint,`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export enum ResponseStatus {`
`24`	`24`	`CANCELLED = 'CANCELLED'`
`25`	`25`	`}`
`26`	`26`
`27`		`-export const GenericResponseSchema = (schema: Schema): Schema => ({ model: schema });`
	`27`	`+export const GenericResponseSchema = <T>(schema: Schema<T>): Schema<GenericResponse<T>> => ({ model: schema });`
`28`	`28`
`29`	`29`	`/**`
`30`	`30`	`* Generic response that contains a model`