rclnodejs 0.32.0 → 0.32.1

package/README.md

@@ -45,7 +45,7 @@ npm i rclnodejs@x.y.z
 
 |                                      RCLNODEJS Version                                       |                                                             Compatible ROS 2 LTS                                                             |
 | :------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: |
-| latest version (currently [v0.32.0](https://github.com/RobotWebTools/rclnodejs/tree/0.32.0)) | [Humble](https://github.com/RobotWebTools/rclnodejs/tree/humble-hawksbill)<br>[Jazzy](https://github.com/RobotWebTools/rclnodejs/tree/jazzy) |
+| latest version (currently [v0.32.1](https://github.com/RobotWebTools/rclnodejs/tree/0.32.1)) | [Humble](https://github.com/RobotWebTools/rclnodejs/tree/humble-hawksbill)<br>[Jazzy](https://github.com/RobotWebTools/rclnodejs/tree/jazzy) |
 
 ## Documentation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rclnodejs",
-  "version": "0.32.0",
+  "version": "0.32.1",
   "description": "ROS2.0 JavaScript client with Node.js",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -23,10 +23,11 @@
     "install": "npm run rebuild",
     "postinstall": "npm run generate-messages",
     "docs": "cd docs && make",
-    "test": "node --expose-gc ./scripts/run_test.js && npx tsd",
+    "test": "nyc node --expose-gc ./scripts/run_test.js && npx tsd",
     "lint": "eslint && node ./scripts/cpplint.js",
     "format": "clang-format -i -style=file ./src/*.cpp ./src/*.hpp && prettier --write \"{lib,rosidl_gen,rostsd_gen,rosidl_parser,types,example,test,scripts,benchmark}/**/*.{js,md,ts}\" ./*.{js,md,ts}",
-    "prepare": "husky"
+    "prepare": "husky",
+    "coverage": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
   },
   "bin": {
     "generate-ros-messages": "./scripts/generate_messages.js"
@@ -49,6 +50,7 @@
     "@typescript-eslint/parser": "^8.18.0",
     "clang-format": "^1.8.0",
     "commander": "^13.1.0",
+    "coveralls": "^3.1.1",
     "deep-equal": "^2.2.3",
     "eslint": "^9.16.0",
     "eslint-config-prettier": "^10.0.2",
@@ -58,7 +60,7 @@
     "jsdoc": "^4.0.4",
     "lint-staged": "^15.2.10",
     "mocha": "^11.0.2",
-    "rimraf": "^6.0.1",
+    "nyc": "^17.1.0",
     "sinon": "^19.0.2",
     "tree-kill": "^1.2.2",
     "tsd": "^0.31.2",
@@ -78,6 +80,7 @@
     "json-bigint": "^1.0.0",
     "nan": "^2.22.0",
     "prettier": "^3.4.2",
+    "rimraf": "^6.0.1",
     "walk": "^2.3.15"
   },
   "husky": {

package/scripts/npmjs-readme.md

@@ -45,7 +45,7 @@ npm i rclnodejs@x.y.z
 
 |                                      RCLNODEJS Version                                       |                                                             Compatible ROS 2 LTS                                                             |
 | :------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: |
-| latest version (currently [v0.32.0](https://github.com/RobotWebTools/rclnodejs/tree/0.32.0)) | [Humble](https://github.com/RobotWebTools/rclnodejs/tree/humble-hawksbill)<br>[Jazzy](https://github.com/RobotWebTools/rclnodejs/tree/jazzy) |
+| latest version (currently [v0.32.1](https://github.com/RobotWebTools/rclnodejs/tree/0.32.1)) | [Humble](https://github.com/RobotWebTools/rclnodejs/tree/humble-hawksbill)<br>[Jazzy](https://github.com/RobotWebTools/rclnodejs/tree/jazzy) |
 
 ## Documentation
 

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"
-  }
-}

package/electron_demo/renderer.js

@@ -1,22 +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 { ipcRenderer } = require('electron');
-
-ipcRenderer.on('topic-received', function (event, response) {
-  document.getElementById('received-topic').innerText = response;
-});
-
-document.getElementById('publish-topic').addEventListener('click', () => {
-  const topic = document.getElementById('topic-input').value;
-  ipcRenderer.send('publish-topic', topic);
-});

package/eslint.config.mjs

@@ -1,65 +0,0 @@
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import prettier from "eslint-plugin-prettier";
-import globals from "globals";
-import tsParser from "@typescript-eslint/parser";
-import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
-import js from "@eslint/js";
-
-export default [
-    {
-        ignores: [
-            "eslint.config.mjs",
-            "types/interfaces.d.ts",
-            "test/types/index.test-d.ts",
-            "**/generated/",
-            "**/scripts/",
-            "**/benchmark/",
-            "**/docs/",
-            "**/electron_demo/",
-        ],
-    },
-    {
-        ...js.configs.recommended,
-        files: ["lib/**/*.js", "index.js"],
-    },
-    {
-        rules: {
-            'no-dupe-class-members': 'off',
-        },
-    },
-    {
-        plugins: {
-            "@typescript-eslint": typescriptEslint,
-        },
-        languageOptions: {
-            globals: {
-                ...globals.node,
-            },
-            parser: tsParser,
-            ecmaVersion: "latest",
-            sourceType: "module",
-        },
-        files: ['types/*.d.ts'],
-        rules: {
-            ...typescriptEslint.configs.recommended.rules,
-            "@typescript-eslint/no-explicit-any": "off",
-        },
-    },
-    {
-        plugins: {
-            prettier,
-        },
-        languageOptions: {
-            globals: {
-                ...globals.node,
-            },
-            ecmaVersion: "latest",
-            sourceType: "commonjs",
-        },
-        files: ["lib/**/*.js", "rosidl_parser/**/*.js", "rosidl_gen/**/*.js",
-            "rostsd_gen/**/*.js", "test/**/*.js", "example/**/*.js", "index.js"],
-        rules: {
-            ...eslintPluginPrettierRecommended.rules,
-        },
-    }
-];

package/suppr.txt

@@ -1,3 +0,0 @@
-leak:librcl.so$
-leak:ref-napi/prebuilds/linux-x64/node.napi.node$
-leak:^napi_module_register$