motion-master-client 0.0.55 → 0.0.56

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": []
+}

package/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

package/README.md

@@ -1,123 +1,123 @@
-# Motion Master Client
-
-Motion Master Client is a library and CLI program written in [TypeScript](https://www.typescriptlang.org). It is used for communicating with Motion Master process over [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) connections by exchanging [Protocol Buffers](https://developers.google.com/protocol-buffers) serialized messages.
-
-## Installation
-
-```sh
-npm install motion-master-client
-```
-
-## Usage
-
-```ts
-const reqResSocket = new MotionMasterReqResWebSocket();
-const pubSubSocket = new MotionMasterPubSubWebSocket();
-
-const client = new MotionMasterClient(reqResSocket, pubSubSocket);
-
-const clientId = v4();
-reqResSocket.open(`ws://oblac-drives-7dc95497.local:63524?clientId=${clientId}`);
-pubSubSocket.open(`ws://oblac-drives-7dc95497.local:63525?clientId=${clientId}`);
-
-client.request.getDeviceInfo().subscribe(console.log);
-```
-
-### Class Diagrams
-
-```mermaid
----
-title: Client & socket classes
----
-classDiagram
-  class MotionMasterClient {
-    +MotionMasterReqResClient request
-    +MotionMasterPubSubClient monitor
-    +startMonitoring()
-    +stopMonitoring()
-  }
-  
-  class MotionMasterReqResClient {
-    +MotionMasterReqResSocket socket
-    note "Has all the request methods\ncorresponding to the proto file."
-  }
-
-  class MotionMasterReqResSocket
-  <<interface>> MotionMasterReqResSocket
-  MotionMasterReqResSocket: +BehaviorSubject~boolean~ opened\$
-  MotionMasterReqResSocket: +BehaviorSubject~boolean~ alive\$
-  MotionMasterReqResSocket: +Observable~MotionMasterMessage~ message\$
-  MotionMasterReqResSocket: +open(string url, number pingSystemInterval?, number systemAliveTimeout?)
-  MotionMasterReqResSocket: +close()
-  MotionMasterReqResSocket: +send(MotionMasterMessage message)
-  
-  class MotionMasterReqResWebSocket {
-    note "Keeps the connection alive by\nsending the ping system messages\nin regular intervals."
-  }
-  
-  class MotionMasterReqResWorkerSocket {
-    +Worker worker
-    note "Passes messages between\nthe UI and worker thread."
-  }
-
-  class MotionMasterPubSubClient {
-    +MotionMasterPubSubSocket socket
-    +Subject<[string, MotionMasterMessage[]]> data\$
-    +Observable~MotionMasterMessage~ notification\$
-    +Observable~MotionMasterMessage~ systemEvent\$
-    +Observable~MotionMasterMessage~ deviceEvent\$
-    +subscribe(MonitoringConfig config)
-    +unsubscribe(string messageId)
-    +unsubscribeAll()
-  }
-
-  class MotionMasterPubSubSocket
-  <<interface>> MotionMasterPubSubSocket
-  MotionMasterPubSubSocket: +BehaviorSubject~boolean~ opened\$
-  MotionMasterPubSubSocket: +Observable<[string, MotionMasterMessage]> data\$
-  MotionMasterPubSubSocket: +open(string url)
-  MotionMasterPubSubSocket: +close()
-
-  class MotionMasterPubSubWebSocket {
-    note "Deserializes incoming data into\na tuple of topic and message."
-  }
-  
-  class MotionMasterPubSubWorkerSocket {
-    +Worker worker
-    note "Passes messages between\nthe UI and worker thread."
-  }
-
-  MotionMasterClient *-- MotionMasterReqResClient
-  MotionMasterClient *-- MotionMasterPubSubClient
-
-  MotionMasterReqResClient *-- MotionMasterReqResSocket
-  MotionMasterReqResWebSocket <|-- MotionMasterReqResSocket
-  MotionMasterReqResWorkerSocket <|-- MotionMasterReqResSocket
-  
-  MotionMasterPubSubClient *-- MotionMasterPubSubSocket
-  MotionMasterPubSubWebSocket <|-- MotionMasterPubSubSocket
-  MotionMasterPubSubWorkerSocket <|-- MotionMasterPubSubSocket
-```
-
-## Communication
-
-### Protocols
-
-### Message Exchange
-
-## Running unit tests
-
-## Features
-
-## Goals
-
-Run `nx test motion-master-client` to execute the unit tests via [Jest](https://jestjs.io).
-
-https://github.com/protocolbuffers/protobuf/issues/2497#issuecomment-267422550
-
-explain status progress completed error
-request timeout
-ping mechanism
-reactive and async api
-two sockets
-matching request id (message id with response)
+# Motion Master Client
+
+Motion Master Client is a library and CLI program written in [TypeScript](https://www.typescriptlang.org). It is used for communicating with Motion Master process over [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) connections by exchanging [Protocol Buffers](https://developers.google.com/protocol-buffers) serialized messages.
+
+## Installation
+
+```sh
+npm install motion-master-client
+```
+
+## Usage
+
+```ts
+const reqResSocket = new MotionMasterReqResWebSocket();
+const pubSubSocket = new MotionMasterPubSubWebSocket();
+
+const client = new MotionMasterClient(reqResSocket, pubSubSocket);
+
+const clientId = v4();
+reqResSocket.open(`ws://oblac-drives-7dc95497.local:63524?clientId=${clientId}`);
+pubSubSocket.open(`ws://oblac-drives-7dc95497.local:63525?clientId=${clientId}`);
+
+client.request.getDeviceInfo().subscribe(console.log);
+```
+
+### Class Diagrams
+
+```mermaid
+---
+title: Client & socket classes
+---
+classDiagram
+  class MotionMasterClient {
+    +MotionMasterReqResClient request
+    +MotionMasterPubSubClient monitor
+    +startMonitoring()
+    +stopMonitoring()
+  }
+  
+  class MotionMasterReqResClient {
+    +MotionMasterReqResSocket socket
+    note "Has all the request methods\ncorresponding to the proto file."
+  }
+
+  class MotionMasterReqResSocket
+  <<interface>> MotionMasterReqResSocket
+  MotionMasterReqResSocket: +BehaviorSubject~boolean~ opened\$
+  MotionMasterReqResSocket: +BehaviorSubject~boolean~ alive\$
+  MotionMasterReqResSocket: +Observable~MotionMasterMessage~ message\$
+  MotionMasterReqResSocket: +open(string url, number pingSystemInterval?, number systemAliveTimeout?)
+  MotionMasterReqResSocket: +close()
+  MotionMasterReqResSocket: +send(MotionMasterMessage message)
+  
+  class MotionMasterReqResWebSocket {
+    note "Keeps the connection alive by\nsending the ping system messages\nin regular intervals."
+  }
+  
+  class MotionMasterReqResWorkerSocket {
+    +Worker worker
+    note "Passes messages between\nthe UI and worker thread."
+  }
+
+  class MotionMasterPubSubClient {
+    +MotionMasterPubSubSocket socket
+    +Subject<[string, MotionMasterMessage[]]> data\$
+    +Observable~MotionMasterMessage~ notification\$
+    +Observable~MotionMasterMessage~ systemEvent\$
+    +Observable~MotionMasterMessage~ deviceEvent\$
+    +subscribe(MonitoringConfig config)
+    +unsubscribe(string messageId)
+    +unsubscribeAll()
+  }
+
+  class MotionMasterPubSubSocket
+  <<interface>> MotionMasterPubSubSocket
+  MotionMasterPubSubSocket: +BehaviorSubject~boolean~ opened\$
+  MotionMasterPubSubSocket: +Observable<[string, MotionMasterMessage]> data\$
+  MotionMasterPubSubSocket: +open(string url)
+  MotionMasterPubSubSocket: +close()
+
+  class MotionMasterPubSubWebSocket {
+    note "Deserializes incoming data into\na tuple of topic and message."
+  }
+  
+  class MotionMasterPubSubWorkerSocket {
+    +Worker worker
+    note "Passes messages between\nthe UI and worker thread."
+  }
+
+  MotionMasterClient *-- MotionMasterReqResClient
+  MotionMasterClient *-- MotionMasterPubSubClient
+
+  MotionMasterReqResClient *-- MotionMasterReqResSocket
+  MotionMasterReqResWebSocket <|-- MotionMasterReqResSocket
+  MotionMasterReqResWorkerSocket <|-- MotionMasterReqResSocket
+  
+  MotionMasterPubSubClient *-- MotionMasterPubSubSocket
+  MotionMasterPubSubWebSocket <|-- MotionMasterPubSubSocket
+  MotionMasterPubSubWorkerSocket <|-- MotionMasterPubSubSocket
+```
+
+## Communication
+
+### Protocols
+
+### Message Exchange
+
+## Running unit tests
+
+## Features
+
+## Goals
+
+Run `nx test motion-master-client` to execute the unit tests via [Jest](https://jestjs.io).
+
+https://github.com/protocolbuffers/protobuf/issues/2497#issuecomment-267422550
+
+explain status progress completed error
+request timeout
+ping mechanism
+reactive and async api
+two sockets
+matching request id (message id with response)

package/jest.config.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: 'motion-master-client',
+  preset: '../../jest.preset.js',
+  globals: {},
+  transform: {
+    '^.+\\.[tj]sx?$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+      },
+    ],
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/libs/motion-master-client',
+};