motion-master-client 0.0.1 → 0.0.2

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [["@nrwl/web/babel", { "useBuiltIns": "usage" }]]
+}

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,7 +1,49 @@
-# motion-master-client
+# Motion Master Client
 
-This library was generated with [Nx](https://nx.dev).
+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}`);
+
+this.client.request.getDeviceInfo().subscribe(console.log);
+```
+
+## 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
+
+class diagram
+
+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,15 @@
+/* eslint-disable */
+export default {
+  displayName: 'motion-master-client',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '../../coverage/libs/motion-master-client',
+};