rclnodejs 0.31.0 → 0.32.1

package/src/rcl_action_bindings.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_RCL_ACTION_BINDINGS_HPP_
-#define RCLNODEJS_RCL_ACTION_BINDINGS_HPP_
+#ifndef SRC_RCL_ACTION_BINDINGS_HPP_
+#define SRC_RCL_ACTION_BINDINGS_HPP_
 
 #include <nan.h>
 #include <rcl/rcl.h>
@@ -28,4 +28,4 @@ extern std::vector<BindingMethod> action_binding_methods;
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_RCL_ACTION_BINDINGS_HPP_

package/src/rcl_bindings.cpp

@@ -40,6 +40,7 @@
 #include <rcl/service_introspection.h>
 #endif
 
+#include <cstdio>
 #include <iostream>
 #include <memory>
 #include <string>
@@ -710,7 +711,6 @@ NAN_METHOD(HasContentFilter) {
   info.GetReturnValue().Set(Nan::False());
   return;
 #else
-
   RclHandle* subscription_handle = RclHandle::Unwrap<RclHandle>(
       Nan::To<v8::Object>(info[0]).ToLocalChecked());
   rcl_subscription_t* subscription =
@@ -964,7 +964,7 @@ NAN_METHOD(SendRequest) {
   THROW_ERROR_IF_NOT_EQUAL(rcl_send_request(client, buffer, &sequence_number),
                            RCL_RET_OK, rcl_get_error_string().str);
 
-  info.GetReturnValue().Set(Nan::New((uint32_t)sequence_number));
+  info.GetReturnValue().Set(Nan::New(static_cast<uint32_t>(sequence_number)));
 }
 
 NAN_METHOD(RclTakeResponse) {
@@ -981,7 +981,7 @@ NAN_METHOD(RclTakeResponse) {
   int64_t sequence_number = header.request_id.sequence_number;
 
   if (ret == RCL_RET_OK) {
-    info.GetReturnValue().Set(Nan::New((uint32_t)sequence_number));
+    info.GetReturnValue().Set(Nan::New(static_cast<uint32_t>(sequence_number)));
     return;
   }
 
@@ -1162,7 +1162,7 @@ NAN_METHOD(ValidateFullTopicName) {
   Nan::Set(
       result_list, 0,
       Nan::New<v8::String>(std::string(validation_message)).ToLocalChecked());
-  Nan::Set(result_list, 1, Nan::New((int32_t)invalid_index));
+  Nan::Set(result_list, 1, Nan::New(static_cast<int32_t>(invalid_index)));
 
   info.GetReturnValue().Set(result_list);
 }
@@ -1197,7 +1197,7 @@ NAN_METHOD(ValidateNodeName) {
   Nan::Set(
       result_list, 0,
       Nan::New<v8::String>(std::string(validation_message)).ToLocalChecked());
-  Nan::Set(result_list, 1, Nan::New((int32_t)invalid_index));
+  Nan::Set(result_list, 1, Nan::New(static_cast<int32_t>(invalid_index)));
 
   info.GetReturnValue().Set(result_list);
 }
@@ -1232,7 +1232,7 @@ NAN_METHOD(ValidateTopicName) {
   Nan::Set(
       result_list, 0,
       Nan::New<v8::String>(std::string(validation_message)).ToLocalChecked());
-  Nan::Set(result_list, 1, Nan::New((int32_t)invalid_index));
+  Nan::Set(result_list, 1, Nan::New(static_cast<int32_t>(invalid_index)));
 
   info.GetReturnValue().Set(result_list);
 }
@@ -1267,7 +1267,7 @@ NAN_METHOD(ValidateNamespace) {
   Nan::Set(
       result_list, 0,
       Nan::New<v8::String>(std::string(validation_message)).ToLocalChecked());
-  Nan::Set(result_list, 1, Nan::New((int32_t)invalid_index));
+  Nan::Set(result_list, 1, Nan::New(static_cast<int32_t>(invalid_index)));
 
   info.GetReturnValue().Set(result_list);
 }

package/src/rcl_bindings.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_RCL_BINDINGS_HPP_
-#define RCLNODEJS_RCL_BINDINGS_HPP_
+#ifndef SRC_RCL_BINDINGS_HPP_
+#define SRC_RCL_BINDINGS_HPP_
 
 #include <nan.h>
 #include <rcl/graph.h>
@@ -43,4 +43,4 @@ extern std::vector<BindingMethod> binding_methods;
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_RCL_BINDINGS_HPP_

package/src/rcl_handle.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_RCL_HANDLE_HPP_
-#define RCLNODEJS_RCL_HANDLE_HPP_
+#ifndef SRC_RCL_HANDLE_HPP_
+#define SRC_RCL_HANDLE_HPP_
 
 #include <nan.h>
 
@@ -68,4 +68,4 @@ class RclHandle : public Nan::ObjectWrap {
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_RCL_HANDLE_HPP_

package/src/rcl_lifecycle_bindings.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_RCL_LIFECYCLE_BINDINGS_HPP_
-#define RCLNODEJS_RCL_LIFECYCLE_BINDINGS_HPP_
+#ifndef SRC_RCL_LIFECYCLE_BINDINGS_HPP_
+#define SRC_RCL_LIFECYCLE_BINDINGS_HPP_
 
 #include <vector>
 
@@ -25,4 +25,4 @@ extern std::vector<BindingMethod> lifecycle_binding_methods;
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_RCL_LIFECYCLE_BINDINGS_HPP_

package/src/rcl_utilities.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_RCL_UTILITIES_HPP_
-#define RCLNODEJS_RCL_UTILITIES_HPP_
+#ifndef SRC_RCL_UTILITIES_HPP_
+#define SRC_RCL_UTILITIES_HPP_
 
 #include <string>
 
@@ -37,4 +37,4 @@ std::string GetErrorMessageAndClear();
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_RCL_UTILITIES_HPP_

package/src/shadow_node.hpp

@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifndef RCLNODEJS_SHADOW_NODE_HPP_
-#define RCLNODEJS_SHADOW_NODE_HPP_
+#ifndef SRC_SHADOW_NODE_HPP_
+#define SRC_SHADOW_NODE_HPP_
 
 #include <nan.h>
 
@@ -60,4 +60,4 @@ class ShadowNode : public Nan::ObjectWrap, public Executor::Delegate {
 
 }  // namespace rclnodejs
 
-#endif
+#endif  // SRC_SHADOW_NODE_HPP_

package/types/action_client.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 declare module 'rclnodejs' {
   type ActionGoal<T> = T extends ActionTypeClassName
     ? InstanceType<ActionsMap[T]['Goal']>

package/types/action_server.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 declare module 'rclnodejs' {
   /**
    * Goal handle for working with Action Servers.

package/types/base.d.ts

@@ -1,28 +1,27 @@
-/* eslint-disable spaced-comment */
-/// <reference path="action_client.d.ts" />
-/// <reference path="action_server.d.ts" />
-/// <reference path="action_uuid.d.ts" />
-/// <reference path="client.d.ts" />
-/// <reference path="clock_type.d.ts" />
-/// <reference path="clock.d.ts" />
-/// <reference path="context.d.ts" />
-/// <reference path="distro.d.ts" />
-/// <reference path="duration.d.ts" />
-/// <reference path="entity.d.ts" />
-/// <reference path="guard_condition.d.ts" />
-/// <reference path="interfaces.d.ts" />
-/// <reference path="lifecycle.d.ts" />
-/// <reference path="lifecycle_publisher.d.ts" />
-/// <reference path="logging.d.ts" />
-/// <reference path="node.d.ts" />
-/// <reference path="node_options.d.ts" />
-/// <reference path="parameter.d.ts" />
-/// <reference path="publisher.d.ts" />
-/// <reference path="qos.d.ts" />
-/// <reference path="rate.d.ts" />
-/// <reference path="service.d.ts" />
-/// <reference path="service_introspection.d.ts" />
-/// <reference path="subscription.d.ts" />
-/// <reference path="time_source.d.ts" />
-/// <reference path="time.d.ts" />
-/// <reference path="timer.d.ts" />
+/// <reference types="./action_client.d.ts" />
+/// <reference types="./action_server.d.ts" />
+/// <reference types="./action_uuid.d.ts" />
+/// <reference types="./client.d.ts" />
+/// <reference types="./clock_type.d.ts" />
+/// <reference types="./clock.d.ts" />
+/// <reference types="./context.d.ts" />
+/// <reference types="./distro.d.ts" />
+/// <reference types="./duration.d.ts" />
+/// <reference types="./entity.d.ts" />
+/// <reference types="./guard_condition.d.ts" />
+/// <reference types="./interfaces.d.ts" />
+/// <reference types="./lifecycle.d.ts" />
+/// <reference types="./lifecycle_publisher.d.ts" />
+/// <reference types="./logging.d.ts" />
+/// <reference types="./node.d.ts" />
+/// <reference types="./node_options.d.ts" />
+/// <reference types="./parameter.d.ts" />
+/// <reference types="./publisher.d.ts" />
+/// <reference types="./qos.d.ts" />
+/// <reference types="./rate.d.ts" />
+/// <reference types="./service.d.ts" />
+/// <reference types="./service_introspection.d.ts" />
+/// <reference types="./subscription.d.ts" />
+/// <reference types="./time_source.d.ts" />
+/// <reference types="./time.d.ts" />
+/// <reference types="./timer.d.ts" />

package/types/index.d.ts

@@ -1,5 +1,4 @@
-// eslint-disable-next-line spaced-comment
-/// <reference path="base.d.ts" />
+/// <reference types="./base.d.ts" />
 
 declare module 'rclnodejs' {
   /**

package/types/lifecycle.d.ts

@@ -53,10 +53,8 @@ declare module 'rclnodejs' {
       asMessage(): {
         transition: SerializedState;
 
-        // eslint-disable-next-line camelcase
         start_state: SerializedState;
 
-        // eslint-disable-next-line camelcase
         goal_state: SerializedState;
       };
     }
@@ -249,7 +247,7 @@ declare module 'rclnodejs' {
        * Register a callback function to be invoked during the deactivate() action.
        * @param  cb - The callback function to invoke.
        */
-      registerOnDectivate(cb: TransitionCallback): void;
+      registerOnDeactivate(cb: TransitionCallback): void;
 
       /**
        * Register a callback function to be invoked during the cleanup() action.

package/types/node.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable camelcase */
 declare module 'rclnodejs' {
   /**
    * Identifies type of ROS message such as msg or srv.

package/types/parameter.d.ts

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 declare module 'rclnodejs' {
   /** 
    * The plus/minus tolerance for determining number equivalence.

package/types/publisher.d.ts

@@ -8,7 +8,6 @@ declare module 'rclnodejs' {
      * Topic on which messages are published.
      */
     readonly topic: string;
-
     /**
      * Publish a message
      *

package/types/time.d.ts

@@ -1,6 +1,4 @@
-/* eslint-disable camelcase */
-
-import { Message, builtin_interfaces } from 'rclnodejs';
+import { builtin_interfaces } from 'rclnodejs';
 
 declare module 'rclnodejs' {
   /**
@@ -100,7 +98,6 @@ declare module 'rclnodejs' {
      *
      * @returns The new Time message.
      */
-    // eslint-disable-next-line camelcase
     toMsg(): builtin_interfaces.msg.Time;
 
     /**
@@ -110,7 +107,6 @@ declare module 'rclnodejs' {
      * @param clockType - The type of the time object. Default is ClockType.ROS_TIME
      * @returns The new Time.
      */
-    // eslint-disable-next-line camelcase
     static fromMsg(
       msg: builtin_interfaces.msg.Time,
       clockType?: ClockType

package/.gitattributes

@@ -1,117 +0,0 @@
-# Based on https://github.com/alexkaratarakis/gitattributes/blob/master/Web.gitattributes
-
-# Auto detect
-##   Handle line endings automatically for files detected as
-##   text and leave all files detected as binary untouched.
-##   This will handle all files NOT defined below.
-*                 text=auto
-
-# Source code
-*.bash            text eol=lf
-*.bat             text eol=crlf
-*.c               text eol=lf
-*.cmd             text eol=crlf
-*.cpp             text eol=lf
-*.css             text diff=css
-*.hpp             text eol=lf
-*.htm             text diff=html
-*.html            text diff=html
-*.inc             text
-*.ini             text
-*.js              text eol=lf
-*.json            text eol=lf
-*.jsx             text eol=lf
-*.less            text
-*.ls              text
-*.map             text -diff
-*.ps1             text eol=crlf
-*.py              text diff=python
-*.sh              text eol=lf
-*.ts              text eol=lf
-*.tsx             text eol=lf
-*.xml             text eol=lf
-*.xhtml           text diff=html
-
-# Templates
-*.em              text eol=lf
-
-# Docker
-Dockerfile        text
-
-# Documentation
-*.ipynb           text
-*.markdown        text diff=markdown
-*.md              text diff=markdown
-*.mdwn            text diff=markdown
-*.mdown           text diff=markdown
-*.mkd             text diff=markdown
-*.mkdn            text diff=markdown
-*.mdtxt           text
-*.mdtext          text
-*.txt             text
-AUTHORS           text
-CHANGELOG         text
-CHANGES           text
-CONTRIBUTING      text
-COPYING           text
-copyright         text
-*COPYRIGHT*       text
-license           text
-LICENSE           text
-readme            text
-*README*          text
-TODO              text
-
-# Configs
-*.cnf             text
-*.conf            text
-*.config          text
-.editorconfig     text
-.env              text
-.gitattributes    text
-.gitconfig        text
-.htaccess         text
-*.lock            text -diff
-*.gyp             text
-package.json      text eol=lf
-package-lock.json text -diff
-pnpm-lock.yaml    text eol=lf -diff
-yarn.lock         text -diff
-*.toml            text
-*.yaml            text eol=lf
-*.yml             text eol=lf
-Makefile          text
-makefile          text
-
-# Graphics
-*.bmp             binary
-*.gif             binary
-*.ico             binary
-*.jng             binary
-*.jp2             binary
-*.jpg             binary
-*.jpeg            binary
-*.jpx             binary
-*.jxr             binary
-*.pdf             binary
-*.png             binary
-# SVG treated as an asset (binary) by default.
-*.svg             text
-# If you want to treat it as binary,
-# use the following line instead.
-# *.svg           binary
-*.svgz            binary
-*.tif             binary
-*.tiff            binary
-*.wbmp            binary
-*.webp            binary
-
-# Executables
-*.exe             binary
-*.pyc             binary
-
-# RC files (like .babelrc or .eslintrc)
-*.*rc             text
-
-# Ignore files (like .npmignore or .gitignore)
-*.*ignore         text

package/CONTRIBUTORS.md

@@ -1,63 +0,0 @@
-# rclnodejs contributors (sorted alphabetically)
-
-- **[Alaa El Jawad](https://github.com/ejalaa12), [Ian McElroy](https://github.com/imcelroy)**
-
-  - Fix compatibility with ROS2 parameters array types
-  - Unit tests for all parameter types
-  - Handle concurrent ROS2 client calls, with unit tests
-
-- **[Alex Mikhalev](https://github.com/amikhalev)**
-
-  - Fix build for AMENT_PREFIX_PATH with multiple entries
-
-- **[Felix Divo](https://github.com/felixdivo)**
-
-  - Code cleanup of index.js, tests cases & message generation
-  - Improved shutdown behavior
-  - Fixed compilation warnings
-
-- **[Hanyia](https://github.com/hanyia)**
-
-  - Benchmark test script
-
-- **[Kenny Yuan](https://github.com/kenny-y)**
-
-  - Message features: JS generation, typed arrays, plain JS object, compound msgs, many others...
-  - npm publish scripts
-  - Mac support
-
-- **[Matt Richard](https://github.com/mattrichard)**
-
-  - ROS2 Actions
-  - Guard conditions
-  - Node utility methods (countPublishers/subscribers...)
-  - TypeScript improvements
-  - Node 12 compatibility
-
-- **[Minggang Wang](https://github.com/minggangw)**
-
-  - Author, lead developer, maintainer
-  - Core, CI
-
-- **[Martins Mozeiko](https://github.com/martins-mozeiko)**
-
-  - QoS new/delete fix
-
-- **[Qiuzhong](https://github.com/qiuzhong)**
-
-  - Test coverage for actions, topics, multi-array messages, cross platform, security
-  - Converted from setTimeout to ROS2 Timer
-
-- **[Teo Koon Peng](https://github.com/koonpeng)**
-
-  - TypeScript improvements
-  - Added Client#waitForService
-  - Code style improvements, e.g., Prettier formatting
-  - Improved code generation smarts and efficiency
-
-- **[Wayne Parrott](https://github.com/wayneparrott)**
-  - TypeScript support with interface generation
-  - ROS2 parameter support
-  - ROS2 lifecycle node
-  - Rate class
-  - Node class hierarchy

package/electron_demo/README.md

@@ -1,54 +0,0 @@
-# Rclnodejs Electron demo
-
-## Introduction
-
-This is a minimal rclnodejs demo using Electron. More information about Electron, please check with [Electron documentation](https://electronjs.org/docs/latest/tutorial/quick-start).
-
-The demo includes the following files:
-
-- `package.json` - Points to the app's main file and lists its details and dependencies.
-- `main.js` - Introduces the `rclnodejs` native module, starts the app and creates a browser window to render HTML. This is the app's **main process**.
-- `index.html` - Includes a text editor where you can input the the topic to be published. This is the app's **renderer process**.
-- `renderer.js` - Communicate with main process to publish a topic and get it through a subscription.
-
-## To run the demo
-
-Before starting, please ensure you have installed [nodejs](https://nodejs.org/en).
-
-1. Clone this repository.
-
-```bash
-git clone https://github.com/RobotWebTools/rclnodejs.git
-```
-
-2. Go into the demo.
-```bash
-cd rclnodejs/electron_demo
-```
-
-3. [SOURCE THE ROS 2 SETUP FILE](https://docs.ros.org/en/jazzy/Tutorials/Beginner-CLI-Tools/Configuring-ROS2-Environment.html#source-the-setup-files)
-
-4. Install dependencies
-```bash
-npm install
-```
-
-5. Rebuild rclnodejs for Electron
-```bash
-# Every time you run "npm install", run this:
-./node_modules/.bin/electron-rebuild
-```
-
-6. Run the app
-```
-npm start
-```
-
-If it works, you can see the demo as:
-![demo screenshot](./electron-demo.gif)
-
-## Resources for Learning Electron
-
-- [electronjs.org/docs](https://electronjs.org/docs) - all of Electron's documentation.
-- [Native Node Modules](https://www.electronjs.org/docs/latest/tutorial/using-native-node-modules) - Use a native node module.
-

package/electron_demo/index.html

@@ -1,25 +0,0 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-  <meta charset="UTF-8">
-  <meta http-equiv="Content-Security-Policy"
-    content="default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'">
-  <title>RCLNODEJS Electron Demo</title>
-</head>
-
-<body>
-  <div>
-    <div style="height: 20px;"></div>
-    <div>
-      <input id="topic-input"></input>
-      <button id="publish-topic">Publish topic</button>
-    </div>
-    <div style="height: 20px;"></div>
-    <span>Received topic:</span>
-    <span id="received-topic"></span>
-  </div>
-  <script src="./renderer.js"></script>
-</body>
-
-</html>

package/electron_demo/main.js

@@ -1,66 +0,0 @@
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-const { app, BrowserWindow } = require('electron')
-let rclnodejs = require("rclnodejs");
-const { ipcMain } = require('electron');
-
-function createWindow() {
-  // Create the browser window.
-  const mainWindow = new BrowserWindow({
-    width: 800,
-    height: 600,
-    webPreferences: {
-      // Add the following two lines in order to use require() in renderer, see details
-      // https://stackoverflow.com/questions/44391448/electron-require-is-not-defined
-      nodeIntegration: true,
-      contextIsolation: false,
-    }
-  });
-
-  mainWindow.loadFile('index.html');
-}
-
-// This method will be called when Electron has finished
-// initialization and is ready to create browser windows.
-// Some APIs can only be used after this event occurs.
-app.whenReady().then(() => {
-  createWindow();
-  rclnodejs.init().then(() => {
-    let sender = null;
-    const node = rclnodejs.createNode('publisher_example_node');
-    node.createSubscription('std_msgs/msg/String', 'topic', (msg) => {
-      if (sender) {
-        sender.send('topic-received', msg.data);
-      }
-    });
-    const publisher = node.createPublisher('std_msgs/msg/String', 'topic');
-    ipcMain.on('publish-topic', (event, topic) => {
-      publisher.publish(topic);
-      sender = event.sender;
-    });
-    rclnodejs.spin(node);
-  });
-
-  app.on('activate', function () {
-    // On macOS it's common to re-create a window in the app when the
-    // dock icon is clicked and there are no other windows open.
-    if (BrowserWindow.getAllWindows().length === 0) createWindow();
-  });
-});
-
-// Quit when all windows are closed, except on macOS. There, it's common
-// for applications and their menu bar to stay active until the user quits
-// explicitly with Cmd + Q.
-app.on('window-all-closed', function () {
-  if (process.platform !== 'darwin') app.quit()
-});

package/electron_demo/package.json

@@ -1,22 +0,0 @@
-{
-  "name": "rclnodejs-electron-demo",
-  "version": "1.0.0",
-  "description": "A minimal rclnodejs Electron application",
-  "main": "main.js",
-  "scripts": {
-    "start": "electron ."
-  },
-  "keywords": [
-    "Electron",
-    "rclnodejs",
-    "demo"
-  ],
-  "license": "Apache",
-  "dependencies": {
-    "rclnodejs": "^0.27.4"
-  },
-  "devDependencies": {
-    "@electron/rebuild": "^3.6.0",
-    "electron": "^31.0.0"
-  }
-}