winusb-driver-generator 1.5.0 → 2.0.0

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,17 @@
+- commits:
+    - subject: "patch: fix linting long lines"
+      hash: 1c449945e94871e64d477284c2ec0d3f0cc8adf1
+      body: ""
+      footer: {}
+      author: mcraa
+    - subject: "major: migrate to NAPI"
+      hash: de012670ef0b6abe303cb345774cab9d6412962e
+      body: ""
+      footer: {}
+      author: mcraa
+  version: 2.0.0
+  title: ""
+  date: 2023-02-13T14:55:46.389Z
 - commits:
     - subject: Add support for Node 18
       hash: f366578887174f2dea005735f92f16ff5cd2f5f8
@@ -8,7 +22,7 @@
       author: Akis Kesoglou
   version: 1.5.0
   title: ""
-  date: 2023-01-20T10:00:09.261Z
+  date: 2023-01-20T10:11:05.406Z
 - commits:
     - subject: "chore(deps): update deps/libwdi digest to 6722681"
       hash: cf7f1a17a93adff95ebed2809f9bfd5c71cdc9e0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## 1.2.3 - 2019-01-11
 
+# v2.0.0
+## (2023-02-13)
+
+* patch: fix linting long lines [mcraa]
+* major: migrate to NAPI [mcraa]
+
 # v1.5.0
 ## (2023-01-20)
 

package/binding.gyp

@@ -193,9 +193,13 @@
     {
       "target_name": "Generator",
       "include_dirs" : [
-        "<!(node -e \"require('nan')\")",
+        "<!@(node -p \"require('node-addon-api').include\")",
         "."
       ],
+      'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
+      "defines": [
+        "NAPI_VERSION=<(napi_build_version)"
+      ],
       "conditions": [
         [ "OS=='win'", {
           "dependencies" : [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "winusb-driver-generator",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "main": "index.js",
   "description": "Associate a USB vendor/product ID pair with WinUSB",
   "homepage": "https://github.com/resin-io-modules/winusb-driver-generator",
@@ -19,14 +19,14 @@
     "configure": "node-gyp configure",
     "build-windows": "node-gyp rebuild",
     "build": "echo npm run build-windows",
-    "rebuild": "prebuild-install || node-gyp rebuild",
+    "rebuild": "prebuild-install --runtime napi || node-gyp rebuild",
     "lint-js": "eslint *.js",
     "lint-cpp": "cpplint --recursive src",
     "lint": "npm run lint-js && npm run lint-cpp",
     "test-windows": "npm run lint",
     "test": "echo npm run test-windows",
-    "install": "prebuild-install || node-gyp rebuild",
-    "prebuilds": "prebuild"
+    "install": "prebuild-install --runtime napi || node-gyp rebuild",
+    "prebuilds": "prebuild --runtime napi"
   },
   "author": "Juan Cruz Viotti <juan@resin.io>",
   "license": "Apache-2.0",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "bindings": "^1.5.0",
-    "nan": "^2.17.0",
+    "node-addon-api": "^5.0.0",
     "prebuild-install": "^7.1.1"
   },
   "gypfile": true,
@@ -52,6 +52,6 @@
     "node": ">=16 < 19"
   },
   "versionist": {
-    "publishedAt": "2023-01-20T10:00:09.411Z"
+    "publishedAt": "2023-02-13T14:55:46.578Z"
   }
 }

package/src/generator.cpp

@@ -15,6 +15,7 @@
  */
 
 #include "src/generator.h"
+#include <napi.h>
 
 static int
 generator_list_driverless_devices(struct wdi_device_info **result) {
@@ -46,10 +47,11 @@ generator_install_winusb_inf(struct wdi_device_info *device,
   return wdi_install_driver(device, path, name, NULL);
 }
 
-NAN_METHOD(listDriverlessDevices) {
+Napi::Value ListDriverlessDevices(const Napi::CallbackInfo& info) {
   int code = WDI_SUCCESS;
   struct wdi_device_info *device_list_node;
-  v8::Local<v8::Object> devices = Nan::New<v8::Array>();
+  Napi::Env env = info.Env();
+  Napi::Object devices = Napi::Array::New(env);
   wdi_set_log_level(WDI_LOG_LEVEL_WARNING);
 
   code = generator_list_driverless_devices(&device_list_node);
@@ -57,22 +59,24 @@ NAN_METHOD(listDriverlessDevices) {
     uint32_t index = 0;
     for (; device_list_node != NULL
          ; device_list_node = device_list_node->next) {
-      v8::Local<v8::Object> device = Nan::New<v8::Object>();
-      Nan::Set(device, Nan::New<v8::String>("vid").ToLocalChecked(),
-        Nan::New<v8::Number>(static_cast<double>(device_list_node->vid)));
-      Nan::Set(device, Nan::New<v8::String>("pid").ToLocalChecked(),
-        Nan::New<v8::Number>(static_cast<double>(device_list_node->pid)));
-      Nan::Set(device, Nan::New<v8::String>("hid").ToLocalChecked(),
-        Nan::New<v8::String>(device_list_node->hardware_id).ToLocalChecked());
-      Nan::Set(device, Nan::New<v8::String>("did").ToLocalChecked(),
-        Nan::New<v8::String>(device_list_node->device_id).ToLocalChecked());
-      Nan::Set(devices, index, device);
+      Napi::Object device = Napi::Object::New(env);
+      device.Set(Napi::String::New(env, "vid"),
+        Napi::Number::New(env, static_cast<double>(device_list_node->vid)));
+      device.Set(Napi::String::New(env, "pid"),
+        Napi::Number::New(env, static_cast<double>(device_list_node->pid)));
+      device.Set(Napi::String::New(env, "hid"),
+        Napi::String::New(env, device_list_node->hardware_id));
+      device.Set(Napi::String::New(env, "did"),
+        Napi::String::New(env, device_list_node->device_id));
+      device.Set(index, device);
       index++;
     }
 
     code = wdi_destroy_list(device_list_node);
     if (code != WDI_SUCCESS) {
-      return Nan::ThrowError(wdi_strerror(code));
+      Napi::TypeError::New(env, wdi_strerror(code))
+        .ThrowAsJavaScriptException();
+      return env.Null();
     }
 
   // This means the returned list is empty.
@@ -81,37 +85,45 @@ NAN_METHOD(listDriverlessDevices) {
   // If the list of driverless devices is empty, then we
   // can assume every device has a driver.
   } else if (code != WDI_ERROR_NO_DEVICE) {
-    return Nan::ThrowError(wdi_strerror(code));
+    Napi::TypeError::New(env, wdi_strerror(code))
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
-  info.GetReturnValue().Set(devices);
+  return devices;
 }
 
-NAN_METHOD(associate) {
+Napi::Value Associate(const Napi::CallbackInfo& info) {
+  Napi::Env env = info.Env();
+
   if (info.Length() != 3) {
-    return Nan::ThrowError("This function expects 3 arguments");
+    Napi::TypeError::New(env, "This function expects 3 arguments")
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
-  if (!info[0]->IsNumber()) {
-    return Nan::ThrowError("Product id must be a number");
+  if (!info[0].IsNumber()) {
+    Napi::TypeError::New(env, "Product id must be a number")
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
-  if (!info[1]->IsNumber()) {
-    return Nan::ThrowError("Vendor id must be a number");
+  if (!info[1].IsNumber()) {
+    Napi::TypeError::New(env, "Vendor id must be a number")
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
-  if (!info[2]->IsString()) {
-    return Nan::ThrowError("Description must be a string");
+  if (!info[2].IsString()) {
+    Napi::TypeError::New(env, "Description must be a string")
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
-  auto context = v8::Isolate::GetCurrent()->GetCurrentContext();
-
-  const uint16_t vendor = info[0]->Uint32Value(context).ToChecked();
-  const uint16_t product = info[1]->Uint32Value(context).ToChecked();
+  const uint32_t vendor = info[0].As<Napi::Number>().Uint32Value();
+  const uint32_t product = info[1].As<Napi::Number>().Uint32Value();
 
-  // TODO(jviotti): Is there a better way to go from v8::String to char *?
-  Nan::Utf8String description_v8(info[2]->ToString(context).ToLocalChecked());
-  std::string description_string = std::string(*description_v8);
+  std::string description_string = info[2].As<Napi::String>().Utf8Value();
   char *description = new char[description_string.length() + 1];
   // cpplint suggests snprintf over strcpy, but the former
   // is not implemented in Visual Studio 2013.
@@ -140,7 +152,9 @@ NAN_METHOD(associate) {
   std::cout << "Extracting driver files" << std::endl;
   code = generator_generate_winusb_inf(&device, INF_NAME, INF_PATH);
   if (code != WDI_SUCCESS) {
-    return Nan::ThrowError(wdi_strerror(code));
+    Napi::TypeError::New(env, wdi_strerror(code))
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
   std::cout << "Installing driver" << std::endl;
@@ -158,28 +172,39 @@ NAN_METHOD(associate) {
   } else if (code == WDI_ERROR_NO_DEVICE) {
     matching_device_found = false;
   } else {
-    return Nan::ThrowError(wdi_strerror(code));
+    Napi::TypeError::New(env, wdi_strerror(code))
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
   code = generator_install_winusb_inf(&device, INF_NAME, INF_PATH);
   if (code != WDI_SUCCESS) {
-    return Nan::ThrowError(wdi_strerror(code));
+    Napi::TypeError::New(env, wdi_strerror(code))
+      .ThrowAsJavaScriptException();
+    return env.Null();
   }
 
   if (matching_device_found) {
     code = wdi_destroy_list(device_list_node);
     if (code != WDI_SUCCESS) {
-      return Nan::ThrowError(wdi_strerror(code));
+      Napi::TypeError::New(env, wdi_strerror(code))
+        .ThrowAsJavaScriptException();
+    return env.Null();
     }
   }
 
   delete [] description;
-  info.GetReturnValue().SetUndefined();
+  return env.Undefined();
 }
 
-NAN_MODULE_INIT(GeneratorInit) {
-  NAN_EXPORT(target, listDriverlessDevices);
-  NAN_EXPORT(target, associate);
+Napi::Object Init(Napi::Env env, Napi::Object exports) {
+  exports.Set(
+    Napi::String::New(env, "listDriverlessDevices"),
+    Napi::Function::New(env, ListDriverlessDevices));
+  exports.Set(
+    Napi::String::New(env, "associate"),
+    Napi::Function::New(env, Associate));
+  return exports;
 }
 
-NODE_MODULE(Generator, GeneratorInit)
+NODE_API_MODULE(Generator, Init)

package/src/generator.h

@@ -18,7 +18,7 @@
  */
 
 #include <stdio.h>
-#include <nan.h>
+#include <napi.h>
 #include <libwdi.h>
 #include <string>
 #include <iostream>
@@ -32,7 +32,7 @@
 #pragma warning(disable:28159)
 #endif
 
-NAN_METHOD(hasDriver);
-NAN_METHOD(associate);
+Napi::Value listDriverlessDevices(const Napi::CallbackInfo& info);
+Napi::Value associate(const Napi::CallbackInfo& info);
 
 #endif  // SRC_GENERATOR_H_