ichiro-its / kumo-client Goto Github PK

As per ichiro-its/kumo#1, also create a simple implementation example for the WebSocket client using simple HTML and JavaScript.

Modify the bridge class as follow:

• Return a promise on the connect function.
• Support to set multiple callback on the Bridge object so it could be called as follow:

  bridge()
    .onConnect(...)
    .onConnect(...)
    .onDisconnect(...);

The currently published package in the npm site not including all the files inside the dist folder, instead, it's including all files inside the src directory and only a single index.js file inside the dist directory. Try removing the files array in the package.json and add a .npmignore file as in this Stack Overflow question.

When calling the connect() function of the Bridge class, the returned promise object is not rejected on connection error, it caused the promise to be never ended.

As in the ichiro-its/kumo#20, also add support for ROS 2 Client in this client library too.

As in the websocket module's readme, the currently used WebSocketClient class only works on Node.js, and not the browser. Hence, it's better to replace the WebSocketClient class with the W3CWebSocket class that works on the browser.

Add linter tests for this project using ESlint and Prettier

Auto generate the library documentation for this project using a generator likes JSDoc, TypeDoc, or else.

Add a prepare script to be run before the package published.

Update the documentation with information regarding to classes usages, functions usages, parameters information, return information, hide unused functions or properties, etc. Follow this guide for more information to fill the documentation using TypeDoc.

Merge any appearance of FooCallback and AsyncFooCallback into a single FooCallback.

Add keywords in the package.json file as in this guide.

As in ichiro-its/kumo#8, also add support for destroy node in this client library too.

As in ichiro-its/kumo#7, also add support for create and destroy publisher in this client library too.

As in the ichiro-its/kumo#19, also add support for ROS 2 Service in this client library too.

Including the docs directory add 4.1 MB to the package size, while the output dist directory only adds 100 KB to the package size. It's better to remove it during the npm packaging.

Create modules to simplify the test of the Kumo package. At first ignore the web support (using Babel, Webpack, etc.) and start with the normal library modules of the JavaScript. It's also better to replace the HTML example with the standard JavaScript executable script.

As in the ichiro-its/kumo#26, modify the ContextHandler class in this library into a SessionHandler class. Also, modify the current Session class into a Bridge class.

Add a continuous integration for this project using GitHub Actions as in this guide.

Update the documentation so it will be ready to be published the package on the npm site under Ichiro ITS name. Publish it after issues #7, #11, and #12 closed.