Merge pull request #4 from tahini/align_tsp

Align client classes with the TSP specification

Author: tahini

src/models/entry.ts

@@ -10,14 +10,19 @@ export interface Entry {
     id: number;
 
     /**
-     * Parent entry Id, or -1 if the entry does not have a parent
+     * Array of string that represant the content of each column
      */
-    parentId: number;
+    labels: string[];
 
     /**
-     * Array of string that represant the content of each column
+     * Parent entry Id. if unset, the entry does not have a parent
      */
-    labels: string[];
+    parentId?: number;
+
+    /**
+     * Indicate if the entry will have row data
+     */
+    hasData?: boolean;
 
     /**
      * Style key used to search for a The style map can be obtained by using the style endpoint.
@@ -33,16 +38,20 @@ export interface EntryHeader {
      * Displayed name
      */
     name: string
+    /**
+     * The description of this header field
+     */
+    tooltip: string
 }
 
 /**
  * Entry model that will be returned by the server
  */
-export interface EntryModel<T extends Entry, U extends EntryHeader> {
+export interface EntryModel<T extends Entry> {
     /**
      * Array of entry header
      */
-    headers: U[];
+    headers: EntryHeader[];
 
     /**
      * Array of entry

src/models/query/query-helper.ts

@@ -17,17 +17,17 @@ export class QueryHelper {
     /**
      * Starting index key
      */
-    public static readonly REQUESTED_TABLE_INDEX_KEY: string = 'requested_table_index';
+    public static readonly REQUESTED_TABLE_INDEX_KEY: string = 'lowIndex';
 
     /**
      * Key for the number of element to return
      */
-    public static readonly REQUESTED_TABLE_COUNT_KEY: string = 'requested_table_count';
+    public static readonly REQUESTED_TABLE_COUNT_KEY: string = 'size';
 
     /**
      * Table column IDs key
      */
-    public static readonly REQUESTED_COLUMN_IDS_KEY = 'requested_table_column_ids';
+    public static readonly REQUESTED_COLUMN_IDS_KEY = 'columnIds';
 
     /**
      * Build a simple query

src/models/styles.ts

@@ -13,7 +13,7 @@ export interface OutputElementStyle {
     /**
      * Style values to override or define properties
      */
-    styleValues: { [key: string]: any };
+    values: { [key: string]: any };
 }
 
 /**

src/models/table.ts

@@ -15,12 +15,12 @@ export interface ColumnHeaderEntry {
     /**
      * Description of the column
      */
-    columnDescription: string;
+    description: string;
 
     /**
      * Hint on the Type of data associated to the column
      */
-    columnType: string;
+    type: string;
 }
 
 /**
@@ -58,18 +58,14 @@ export interface Cell {
     tags: number;
 }
 
-export interface ColumnsModel {
-    columns: ColumnHeaderEntry[];
-}
-
 /**
  * Model of a table
  */
 export interface TableModel {
     /**
      * Index of the first returned line
      */
-    index: number;
+    lowIndex: number;
 
     /**
      * Number of lines

src/models/timegraph.ts

@@ -5,25 +5,15 @@ import { OutputElementStyle } from './styles';
  * Entry in a time graph
  */
 export interface TimeGraphEntry extends Entry {
-    /**
-     * Type of the entry
-     */
-    type: string;
-
     /**
      * Start time of the entry
      */
-    startTime: number;
+    start: number;
 
     /**
      * End time of the entry
      */
-    endTime: number;
-
-    /**
-     * Indicate if the entry will have row data
-     */
-    hasRowModel: boolean;
+    end: number;
 }
 
 /**
@@ -55,27 +45,22 @@ export interface TimeGraphState {
     /**
      * Start time of the state
      */
-    startTime: number;
+    start: number;
 
     /**
      * End time of the state
      */
-    duration: number;
+    end: number;
 
     /**
      * Label to apply to the state
      */
-    label: string;
-
-    /**
-     * Values associated to the state
-     */
-    value: number;
+    label?: string;
 
     /**
      * Tags for the state, used when the state pass a filter
      */
-    tags: number;
+    tags?: number;
 
     /**
      * Optional information on the style to format this state
@@ -95,22 +80,17 @@ export interface TimeGraphArrow {
     /**
      * Destination entry Id for the arrow
      */
-    destinationId: number;
+    targetId: number;
 
     /**
      * Start time of the arrow
      */
-    startTime: number;
+    start: number;
 
     /**
      * Duration of the arrow
      */
-    duration: number;
-
-    /**
-     * Value associated to the arrow
-     */
-    value: number;
+    end: number;
 
     /**
      * Optional information on the style to format this arrow

src/models/xy.ts

@@ -15,7 +15,7 @@ export interface XYModel {
     /**
      * Array of XY series
      */
-    series: { [key: string]: XYSeries };
+    series: XYSeries[];
 }
 
 /**
@@ -25,22 +25,22 @@ export interface XYSeries {
     /**
      * Name of the series
      */
-    name: string;
+    seriesName: string;
 
     /**
      * Ìd of the series
      */
-    id: string;
+    seriesId: number;
 
     /**
      * Description of the X axis
      */
-    xAxis: Axis;
+    xAxis: XYAxis;
 
     /**
      * Description of the Y axis
      */
-    yAxis: Axis;
+    yAxis: XYAxis;
 
     /**
      * Series' X values
@@ -61,14 +61,19 @@ export interface XYSeries {
 /**
  * Description of an axis for XY chart
  */
-export interface Axis {
+export interface XYAxis {
     /**
      * Label of the axis
      */
     label: string;
 
     /**
-     * Type of units used for the axis
+     * The units used for the axis, to be appended to the numbers
      */
     unit: string;
+
+    /**
+     * Type of data for this axis, to give hint on number formatting
+     */
+    dataType: string;
 }

src/protocol/tsp-client.ts

@@ -1,8 +1,8 @@
 import { Query } from '../models/query/query';
 import { GenericResponse } from '../models/response/responses';
 import { XYModel } from '../models/xy';
-import { TimeGraphArrow, TimeGraphModel } from '../models/timegraph';
-import { TableModel } from '../models/table';
+import { TimeGraphEntry, TimeGraphArrow, TimeGraphModel } from '../models/timegraph';
+import { TableModel, ColumnHeaderEntry } from '../models/table';
 import { Trace } from '../models/trace';
 import { RestClient } from './rest-client';
 import { Experiment } from '../models/experiment';
@@ -137,24 +137,24 @@ export class TspClient {
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Generic entry response with entries of type T
+     * @returns Generic entry response with entries
      */
-    public async fetchXYTree<M extends Entry, H extends EntryHeader>(expUUID: string,
-        outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<EntryModel<M, H>>>> {
+    public async fetchXYTree(expUUID: string,
+        outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<EntryModel<Entry>>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/XY/' + outputID + '/tree';
-        return await RestClient.post<GenericResponse<EntryModel<M, H>>>(url, parameters);
+        return await RestClient.post<GenericResponse<EntryModel<Entry>>>(url, parameters);
     }
 
     /**
      * Fetch XY. model extends XYModel
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns XY model response with the model of type T
+     * @returns XY model response with the model
      */
-    public async fetchXY<T extends XYModel>(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<T>>> {
+    public async fetchXY(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<XYModel>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/XY/' + outputID + '/xy';
-        return await RestClient.post<GenericResponse<T>>(url, parameters);
+        return await RestClient.post<GenericResponse<XYModel>>(url, parameters);
     }
 
     /**
@@ -186,36 +186,36 @@ export class TspClient {
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Time graph entry response with entries of type T and headers of type U
+     * @returns Time graph entry response with entries of type TimeGraphEntry
      */
-    public async fetchTimeGraphTree<M extends Entry, H extends EntryHeader>(expUUID: string,
-        outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<EntryModel<M, H>>>> {
+    public async fetchTimeGraphTree(expUUID: string,
+        outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<EntryModel<TimeGraphEntry>>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/timeGraph/' + outputID + '/tree';
-        return await RestClient.post<GenericResponse<EntryModel<M, H>>>(url, parameters);
+        return await RestClient.post<GenericResponse<EntryModel<TimeGraphEntry>>>(url, parameters);
     }
 
     /**
      * Fetch Time Graph states. Model extends TimeGraphModel
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Generic response with the model of type T
+     * @returns Generic response with the model
      */
-    public async fetchTimeGraphStates<T extends TimeGraphModel>(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<T>>> {
+    public async fetchTimeGraphStates(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<TimeGraphModel>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/timeGraph/' + outputID + '/states';
-        return await RestClient.post<GenericResponse<T>>(url, parameters);
+        return await RestClient.post<GenericResponse<TimeGraphModel>>(url, parameters);
     }
 
     /**
      * Fetch Time Graph arrows. Model extends TimeGraphArrow
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Generic response with the model of type T
+     * @returns Generic response with the model
      */
-    public async fetchTimeGraphArrows<T extends TimeGraphArrow>(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<T>>> {
+    public async fetchTimeGraphArrows(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<TimeGraphArrow>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/timeGraph/' + outputID + '/arrows';
-        return await RestClient.post<GenericResponse<T>>(url, parameters);
+        return await RestClient.post<GenericResponse<TimeGraphArrow>>(url, parameters);
     }
 
     /**
@@ -246,35 +246,35 @@ export class TspClient {
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Generic entry response with entries of type T
+     * @returns Generic entry response with columns headers as model
      */
-    public async fetchTableColumns<M extends Entry, H extends EntryHeader>(expUUID: string,
-        outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<EntryModel<M, H>>>> {
+    public async fetchTableColumns(expUUID: string,
+        outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<ColumnHeaderEntry[]>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/table/' + outputID + '/columns';
-        return await RestClient.post<GenericResponse<EntryModel<M, H>>>(url, parameters);
+        return await RestClient.post<GenericResponse<ColumnHeaderEntry[]>>(url, parameters);
     }
 
     /**
      * Fetch Table lines
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Generic response with the model of type T
+     * @returns Generic response with the model
      */
-    public async fetchTableLines<T extends TableModel>(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<T>>> {
+    public async fetchTableLines(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<TableModel>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/table/' + outputID + '/lines';
-        return await RestClient.post<GenericResponse<T>>(url, parameters);
+        return await RestClient.post<GenericResponse<TableModel>>(url, parameters);
     }
 
     /**
      * Fetch output styles
      * @param expUUID Experiment UUID
      * @param outputID Output ID
      * @param parameters Query object
-     * @returns Generic response with the model of type T
+     * @returns Generic response with the model
      */
-    public async fetchStyles<T extends OutputStyleModel>(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<T>>> {
+    public async fetchStyles(expUUID: string, outputID: string, parameters: Query): Promise<TspClientResponse<GenericResponse<OutputStyleModel>>> {
         const url = this.baseUrl + '/experiments/' + expUUID + '/outputs/' + outputID + '/style';
-        return await RestClient.post<GenericResponse<T>>(url, parameters);
+        return await RestClient.post<GenericResponse<OutputStyleModel>>(url, parameters);
     }
 }

tsconfig.json

@@ -1,6 +1,5 @@
 {
     "compilerOptions": {
-        "composite": true,
         "declaration": true,
         "declarationMap": true,
         "sourceMap": true,