docs(ts): Add and update TypeScript definitions

Author: luciemac

Sources/IO/Core/ImageStream/ViewStream.d.ts

@@ -0,0 +1,241 @@
+import { vtkObject } from '../../../interfaces';
+
+/**
+ *
+ */
+export interface IViewStreamInitialValues {
+  protocol?: any;
+  api?: any;
+  cameraUpdateRate?: number;
+  decodeImage?: boolean;
+  fpsWindowSize?: number;
+  interactiveQuality?: number;
+  interactiveRatio?: number;
+  isAnimating?: boolean;
+  mimeType?: string;
+  size?: number[];
+  stillQuality?: number;
+  stillRatio?: number;
+  useCameraParameters?: boolean;
+  viewId?: string;
+}
+
+export interface vtkViewStream extends vtkObject {
+  /**
+   *
+   * @param callback
+   */
+  onImageReady(callback: () => void): any;
+
+  /**
+   *
+   */
+  getViewId(): string;
+
+  /**
+   *
+   */
+  getSize(): number[];
+
+  /**
+   *
+   */
+  getFps(): any;
+
+  /**
+   *
+   */
+  getLastImageEvent(): any;
+
+  /**
+   *
+   */
+  getCamera(): any;
+
+  /**
+   *
+   * @param camera
+   */
+  setCamera(camera: any): boolean;
+
+  /**
+   *
+   */
+  getCameraUpdateRate(): number;
+
+  /**
+   *
+   * @param cameraUpdateRate
+   */
+  setCameraUpdateRate(cameraUpdateRate: number): boolean;
+
+  /**
+   *
+   */
+  getDecodeImage(): any;
+
+  /**
+   *
+   * @param decodeImage
+   */
+  setDecodeImage(decodeImage: boolean): boolean;
+
+  /**
+   *
+   */
+  getFpsWindowSize(): number;
+
+  /**
+   *
+   * @param fpsWindowSize
+   */
+  setFpsWindowSize(fpsWindowSize: number): boolean;
+
+  /**
+   *
+   */
+  getInteractiveQuality(): number;
+
+  /**
+   *
+   * @param interactiveQuality
+   */
+  setInteractiveQuality(interactiveQuality: number): boolean;
+
+  /**
+   *
+   */
+  getInteractiveRatio(): number;
+
+  /**
+   *
+   * @param interactiveRatio
+   */
+  setInteractiveRatio(interactiveRatio: number): boolean;
+
+  /**
+   *
+   */
+  getStillQuality(): number;
+
+  /**
+   *
+   * @param stillQuality
+   */
+  setStillQuality(stillQuality: number): boolean;
+
+  /**
+   *
+   */
+  getStillRatio(): number;
+
+  /**
+   *
+   * @param stillRatio
+   */
+  setStillRatio(stillRatio: number): boolean;
+
+  /**
+   *
+   */
+  getUseCameraParameters(): boolean;
+
+  /**
+   *
+   * @param useCameraParameters
+   */
+  setUseCameraParameters(useCameraParameters: boolean): boolean;
+
+  /**
+   *
+   */
+  pushCamera(): any;
+
+  /**
+   *
+   */
+  invalidateCache(): any;
+
+  /**
+   *
+   */
+  render(): any;
+
+  /**
+   *
+   */
+  resetCamera(): any;
+
+  /**
+   *
+   */
+  startAnimation(): any;
+
+  /**
+   *
+   */
+  stopAnimation(): any;
+
+  /**
+   *
+   * @param width
+   * @param height
+   */
+  setSize(width: number, height: number): any;
+
+  /**
+   *
+   */
+  startInteraction(): any;
+
+  /**
+   *
+   */
+  endInteraction(): any;
+
+  /**
+   *
+   * @param viewId
+   */
+  setViewId(viewId: string): boolean;
+
+  /**
+   *
+   * @param msg
+   */
+  processMessage(msg: any): void;
+
+  /**
+   *
+   */
+  delete(): void;
+}
+
+/**
+ * Method used to decorate a given object (publicAPI+model) with vtkViewStream characteristics.
+ * @param publicAPI
+ * @param model
+ * @param initialValues
+ */
+export function extend(
+  publicAPI: object,
+  model: object,
+  initialValues?: IViewStreamInitialValues
+): void;
+
+/**
+ * Method used to create a new instance of vtkViewStream
+ * @param {IViewStreamInitialValues} [initialValues] for pre-setting some of its content
+ */
+export function newInstance(
+  initialValues?: IViewStreamInitialValues
+): vtkViewStream;
+
+/**
+ * IViewStreamInitialValues provides a way to create a remote view.
+ */
+export declare const vtkViewStream: {
+  newInstance: typeof newInstance;
+  extend: typeof extend;
+};
+export default vtkViewStream;

Sources/IO/Core/WSLinkClient/index.d.ts

@@ -1,4 +1,4 @@
-import { vtkObject, vtkSubscription } from "../../../interfaces";
+import { vtkObject, vtkSubscription } from '../../../interfaces';
 
 /**
  * Bind optional dependency from WSLink to our current class.
@@ -15,7 +15,6 @@ import { vtkObject, vtkSubscription } from "../../../interfaces";
  */
 export function setSmartConnectClass(smartConnectClass: object): void;
 
-
 export interface vtkWSLinkClient extends vtkObject {
 
   /**
@@ -117,21 +116,45 @@ export interface vtkWSLinkClient extends vtkObject {
    */
   getConfigDecorator(): (config: object) => object;
 
-  getConnection(): object;
-  getCongig(): object;
+  /**
+   *
+   */
+  getConnection(): any;
+
+  /**
+   *
+   */
+  getConfig(): object;
+
+  /**
+   *
+   */
   getRemote(): object;
+
+  /**
+   *
+   */
   getImageStream(): object;
 
+  /**
+   *
+   * @param callback
+   * @param priority
+   */
   onBusyChange(callback: Function, priority: number): vtkSubscription;
+
+  /**
+   *
+   */
   invokeBusyChange(): void;
 
-  onConnectionReady(callback: () => void): vtkSubscription;
+  onConnectionReady(callback: (httpReq: any) => void): vtkSubscription;
   // invokeConnectionReady(): void
 
-  onConnectionError(callback: () => void): vtkSubscription;
+  onConnectionError(callback: (httpReq: any) => void): vtkSubscription;
   // invokeConnectionError(): void
 
-  onConnectionClose(callback: () => void): vtkSubscription;
+  onConnectionClose(callback: (httpReq: any) => void): vtkSubscription;
   // invokeConnectionClose(): void
 }