feat: add CMake/npm options for Curve, Draft, Sodium, Websockets

Author: aminya

CMakeLists.txt

@@ -1,10 +1,54 @@
 cmake_minimum_required(VERSION 3.16)
 
-include(FetchContent)
-if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
-  cmake_policy(SET CMP0135 NEW)
+macro(set_option_from_env OPTION_NAME)
+  string(TOLOWER ${OPTION_NAME} OPTION_NAME_LOWER)
+  if(DEFINED ENV{npm_config_${OPTION_NAME_LOWER}})
+    if("$ENV{npm_config_${OPTION_NAME_LOWER}}" STREQUAL "true")
+      set("${OPTION_NAME}"
+          ON
+          CACHE BOOL "npm_config_${OPTION_NAME_LOWER}")
+    elseif("$ENV{npm_config_${OPTION_NAME_LOWER}}" STREQUAL "false")
+      set("${OPTION_NAME}"
+          OFF
+          CACHE BOOL "npm_config_${OPTION_NAME_LOWER}")
+    else()
+      set("${OPTION_NAME}"
+          "$ENV{npm_config_${OPTION_NAME_LOWER}}"
+          CACHE STRING "npm_config_${OPTION_NAME_LOWER}")
+    endif()
+  endif()
+  if(${OPTION_NAME})
+    string(REPLACE "zmq_" "" OPTION_NAME_LOWER "${OPTION_NAME_LOWER}")
+    string(REPLACE "_" "-" OPTION_NAME_LOWER "${OPTION_NAME_LOWER}")
+    list(APPEND VCPKG_MANIFEST_FEATURES ${OPTION_NAME_LOWER})
+  endif()
+  message(STATUS "${OPTION_NAME}: ${${OPTION_NAME}}")
+endmacro()
+
+option(ZMQ_DRAFT "Build and install draft APIs" OFF)
+set_option_from_env(ZMQ_DRAFT)
+
+option(ZMQ_CURVE "Enable CURVE security" OFF)
+set_option_from_env(ZMQ_CURVE)
+
+option(ZMQ_SODIUM "Using libsodium for CURVE security" OFF)
+set_option_from_env(ZMQ_SODIUM)
+
+option(ZMQ_WEBSOCKETS "Enable WebSocket transport" OFF)
+set_option_from_env(ZMQ_WEBSOCKETS)
+
+option(ZMQ_WEBSOCKETS_SECURE "Enable WebSocket transport with TSL (wss)" OFF)
+set_option_from_env(ZMQ_WEBSOCKETS_SECURE)
+
+option(ZMQ_NO_SYNC_RESOLVE "send/receive on the socket immediately" OFF)
+set_option_from_env(ZMQ_NO_SYNC_RESOLVE)
+
+if(APPLE)
+  option(MACOSX_DEPLOYMENT_TARGET "MacOS deployment target" "10.15")
+  set_option_from_env(MACOSX_DEPLOYMENT_TARGET)
 endif()
 
+# MacOS deployment target
 if(WIN32)
   if("${PLATFORM}" STREQUAL "x86")
     set(CMAKE_SYSTEM_PROCESSOR "x86")
@@ -19,6 +63,11 @@ if(WIN32)
   set(CMAKE_TOOLCHAIN_FILE ";")
 endif()
 
+include(FetchContent)
+if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+  cmake_policy(SET CMP0135 NEW)
+endif()
+
 # Add project_options from https://github.com/aminya/project_options Change the
 # version in the following URL to update the package (watch the releases of the
 # repository for future updates)
@@ -60,6 +109,13 @@ add_library(
 
 target_link_libraries(addon PRIVATE project_options project_warnings)
 
+if(ZMQ_DRAFT)
+  target_compile_definitions(addon PRIVATE ZMQ_BUILD_DRAFT_API)
+endif()
+if(ZMQ_NO_SYNC_RESOLVE)
+  target_compile_definitions(addon PRIVATE ZMQ_NO_SYNC_RESOLVE)
+endif()
+
 # ZeroMQ
 find_package(ZeroMQ CONFIG REQUIRED)
 target_link_system_libraries(addon PRIVATE libzmq libzmq-static)

README.md

@@ -22,18 +22,39 @@
 
 ## Table of contents
 
-- [Installation](#installation)
-  - [Prebuilt binaries](#prebuilt-binaries)
-  - [Building from source](#building-from-source)
-- [Examples](#examples)
-  - [Push/Pull](#pushpull)
-  - [Pub/Sub](#pubsub)
-  - [Req/Rep](#reqrep)
+- [ZeroMQ.js Next Generation](#zeromqjs-next-generation)
+  - [Useful links](#useful-links)
+  - [Table of contents](#table-of-contents)
+  - [Installation](#installation)
+    - [Prebuilt binaries](#prebuilt-binaries)
+    - [Building from source](#building-from-source)
+    - [Available Build Options](#available-build-options)
+    - [Curve support](#curve-support)
+    - [Libsodium for Curve](#libsodium-for-curve)
+      - [Draft support](#draft-support)
+      - [Websocket support](#websocket-support)
+      - [Secure Websocket support](#secure-websocket-support)
+      - [Not Synchronous Resolve](#not-synchronous-resolve)
+      - [MacOS Deployment Target](#macos-deployment-target)
+  - [Examples](#examples)
+    - [Basic Usage](#basic-usage)
+    - [Push/Pull](#pushpull)
+      - [`producer.js`](#producerjs)
+      - [`worker.js`](#workerjs)
+    - [Pub/Sub](#pubsub)
+      - [`publisher.js`](#publisherjs)
+      - [`subscriber.js`](#subscriberjs)
+    - [Req/Rep](#reqrep)
+      - [`client.js`](#clientjs)
+      - [`server.js`](#serverjs)
+  - [Zeromq 4 and 5 Compatibility layer](#zeromq-4-and-5-compatibility-layer)
   - [TypeScript](#typescript)
-  - [More examples](#more-examples)
-  - [Compatibility layer for version 4/5](#compatibility-layer-for-version-45)
-- [Contribution](#contribution)
-- [History](#history)
+  - [Contribution](#contribution)
+    - [Dependencies](#dependencies)
+    - [Defining new options](#defining-new-options)
+    - [Testing](#testing)
+    - [Publishing](#publishing)
+  - [History](#history)
 
 ## Installation
 
@@ -76,9 +97,9 @@ during build, you can build this package from source.
 Make sure you have the following installed before attempting to build from
 source:
 
-- Node.js 10+ or Electron 3+
+- Node.js 12+ or Electron
 - A working C++17 compiler toolchain with make
-- Python 3 with Node 12.13+ (or legacy Python 2.7)
+- Python 3 with Node 12+ (or legacy Python 2.7)
 - CMake 2.8+
 - curl
 
@@ -96,67 +117,62 @@ When building from source, you can also specify additional build options in a
 <details>
 <summary>👉🏻 Options</summary>
 
-#### Draft support
+### Curve support
 
-By default `libzmq` is built with support for `Draft` patterns (e.g.
-`server-client`, `radio-dish`, `scatter-gather`). If you want to build `libzmq`
-without support for `Draft`, you can specify the following in `.npmrc`:
+Enables CURVE security for encrypted communications. To enable CURVE support, add the following to your .npmrc:
 
 ```ini
-zmq_draft=false
+zmq_curve="true"
 ```
 
-#### Not Synchronous Resolve
+### Libsodium for Curve
 
-If you want to send/receive on the socket immediately, you can specify the
-following in `.npmrc`:
+Enable libsodium for CURVE security instead of the built-in tweetnacl implementation. This can provide better performance for CURVE operations. To use libsodium, add the following to your .npmrc:
 
 ```ini
-zmq_no_sync_resolve="true"
+zmq_sodium="true"
 ```
 
-#### Shared library support
+#### Draft support
 
-If you want to link against a shared ZeroMQ library installed on your system,
-you can build skip downloading `libzmq` and link with the installed library
-instead by specifying the following in `.npmrc`:
+By default `libzmq` is built with support for `Draft` patterns (e.g.
+`server-client`, `radio-dish`, `scatter-gather`). If you want to build `libzmq`
+without support for `Draft`, you can specify the following in `.npmrc`:
 
 ```ini
-zmq_shared=true
+zmq_draft=false
 ```
 
-#### Alternative libzmq version
+#### Websocket support
 
-You can specify an alternative version or Git revision of `libzmq` to build
-against by specifying the following in `.npmrc`:
+Enables WebSocket transport, allowing ZeroMQ to communicate over WebSockets. To enable WebSocket support, add the following to your .npmrc:
 
 ```ini
-zmq_version="4.3.5"
+zmq_websockets="true"
 ```
 
-#### Debug build of libzmq
+#### Secure Websocket support
 
-If you want to build `libzmq` with debug symbols, you can specify the following
-in `.npmrc`:
+Enables WebSocket transport with TLS (wss), providing secure WebSocket communications. To enable secure WebSocket support, add the following to your .npmrc:
 
 ```ini
-zmq_build_type="Debug"
+zmq_websockets_secure="true"
 ```
 
-#### Cross-compilation for different architectures
+#### Not Synchronous Resolve
 
-If you want to cross-compile for a different architecture, you can specify the
-following in `.npmrc`:
+Enables immediate send/receive on the socket without synchronous resolution.
+This option can improve performance in certain scenarios by allowing operations
+to proceed without waiting for synchronous resolution. To enable this feature,
+add the following to your `.npmrc`:
 
 ```ini
-arch="arm64"
-target_arch="arm64"
+zmq_no_sync_resolve="true"
 ```
 
 #### MacOS Deployment Target
 
-If you want to specify the MacOS deployment target, you can specify the
-following in `.npmrc`:
+Specifies the minimum macOS version that the binary will be compatible with. This is particularly useful when building for different macOS versions. To set this, add the following to your .npmrc, replacing 10.15 with your desired minimum macOS version:
 
 ```ini
 macos_deployment_target="10.15"

vcpkg.json

@@ -6,8 +6,64 @@
   "dependencies": [
     {
       "name": "zeromq",
-      "version>=": "4.3.5#2",
-      "features": []
+      "version>=": "4.3.5#2"
     }
-  ]
+  ],
+  "features": {
+    "curve": {
+      "description": "Enable CURVE security",
+      "dependencies": [
+        {
+          "name": "zeromq",
+          "features": [
+            "curve"
+          ]
+        }
+      ]
+    },
+    "draft": {
+      "description": "Build and install draft APIs",
+      "dependencies": [
+        {
+          "name": "zeromq",
+          "features": [
+            "draft"
+          ]
+        }
+      ]
+    },
+    "sodium": {
+      "description": "Using libsodium for CURVE security",
+      "dependencies": [
+        {
+          "name": "zeromq",
+          "features": [
+            "sodium"
+          ]
+        }
+      ]
+    },
+    "websockets": {
+      "description": "Enable WebSocket transport",
+      "dependencies": [
+        {
+          "name": "zeromq",
+          "features": [
+            "websockets"
+          ]
+        }
+      ]
+    },
+    "websockets-secure": {
+      "description": "Enable WebSocket transport with TSL (wss)",
+      "dependencies": [
+        {
+          "name": "zeromq",
+          "features": [
+            "websockets-secure"
+          ]
+        }
+      ]
+    }
+  }
 }