@lynx-js/lynx-library-headers 0.0.1-alpha.4 → 0.0.1-alpha.7

package/README.md

@@ -1,8 +1,8 @@
 # @lynx-js/lynx-library-headers
 
 Header package for Lynx embedder C/C++ API and weak N-API based native
-libraries. This package only provides headers; it does not scaffold, build, or
-register libraries.
+libraries. This package provides headers and CMake helpers; it does not
+scaffold, build, or register libraries.
 
 ## Usage
 
@@ -12,10 +12,22 @@ native target include directories:
 ```js
 const path = require('node:path');
 const headersRoot = path.dirname(
-  require.resolve('@lynx-js/lynx-library-headers/package.json'),
+  require.resolve('@lynx-js/lynx-library-headers/package.json')
 );
 ```
 
+For Windows Lynx native library builds, include the packaged CMake helper to
+resolve the host runtime import library used by the generated native target:
+
+```cmake
+include("${headersRoot}/cmake/lynx-library-headers.cmake")
+lynx_link_lynxtron_runtime(your_target)
+```
+
+The helper resolves the Windows import library from the runtime package
+installed with `@lynx-js/lynx-library-headers`. You can override discovery with
+`-DLYNXTRON_IMPORT_LIB=/path/to/lynxtron.dll.lib`.
+
 The published package contains:
 
 - Lynx embedder C API headers.
@@ -25,8 +37,10 @@ The published package contains:
 - Lynx value C API headers required by the embedder C API.
 - `lynx_extension.h` and `lynx/extension.h` convenience wrapper headers.
 - `lynx/registration.h` for generic embedder static registration helpers.
+- `cmake/lynx-library-headers.cmake` for resolving Windows runtime import
+  libraries used by Lynx native library builds.
 
-Embedders and Lynxtron packages use static registration from the native library:
+Lynx native libraries use static registration from the native library:
 
 ```cpp
 #include <lynx/registration.h>
@@ -47,7 +61,7 @@ Use `LYNX_REGISTER_NATIVE_MODULE` for Lynx weak N-API native modules and
 both features should call both macros, keeping the native module and element
 registrations separate.
 
-Lynxtron loads matching native libraries through its autolink flow; loading the
-library is enough for these static registrations to run.
+A host runtime that loads the native library is enough for these static
+registrations to run.
 
 Run `npm run copy-headers` in this package when updating the source headers.

package/cmake/lynx-library-headers.cmake

@@ -0,0 +1,136 @@
+if(NOT COMMAND lynx_resolve_node_package)
+  function(lynx_resolve_node_package PACKAGE_NAME OUT_VAR)
+    if(NOT DEFINED NODE_EXECUTABLE)
+      find_program(NODE_EXECUTABLE NAMES node)
+    endif()
+
+    if(NOT NODE_EXECUTABLE)
+      message(FATAL_ERROR "Unable to find node. Install Node.js before configuring Lynx library targets.")
+    endif()
+
+    if(NOT DEFINED LYNX_LIBRARY_PACKAGE_ROOT)
+      set(LYNX_LIBRARY_PACKAGE_ROOT "${CMAKE_CURRENT_SOURCE_DIR}")
+    endif()
+
+    execute_process(
+      COMMAND
+        "${NODE_EXECUTABLE}"
+        -p
+        "require('node:path').dirname(require.resolve('${PACKAGE_NAME}/package.json'))"
+      WORKING_DIRECTORY "${LYNX_LIBRARY_PACKAGE_ROOT}"
+      RESULT_VARIABLE NODE_PACKAGE_RESULT
+      OUTPUT_VARIABLE NODE_PACKAGE_ROOT
+      ERROR_VARIABLE NODE_PACKAGE_ERROR
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+
+    if(NOT NODE_PACKAGE_RESULT EQUAL 0 OR NOT NODE_PACKAGE_ROOT)
+      string(REPLACE "\n" " " NODE_PACKAGE_ERROR "${NODE_PACKAGE_ERROR}")
+      message(FATAL_ERROR "Unable to resolve ${PACKAGE_NAME}. Run npm install first. ${NODE_PACKAGE_ERROR}")
+    endif()
+
+    set(${OUT_VAR} "${NODE_PACKAGE_ROOT}" PARENT_SCOPE)
+  endfunction()
+endif()
+
+get_filename_component(
+  LYNX_LIBRARY_HEADERS_PACKAGE_ROOT
+  "${CMAKE_CURRENT_LIST_DIR}/.."
+  ABSOLUTE
+)
+
+function(lynx_resolve_lynxtron_import_library OUT_VAR)
+  if(NOT WIN32)
+    set(${OUT_VAR} "" PARENT_SCOPE)
+    return()
+  endif()
+
+  if(DEFINED LYNXTRON_IMPORT_LIB)
+    file(TO_CMAKE_PATH "${LYNXTRON_IMPORT_LIB}" LYNXTRON_IMPORT_LIB_PATH)
+    if(NOT EXISTS "${LYNXTRON_IMPORT_LIB_PATH}")
+      message(FATAL_ERROR "LYNXTRON_IMPORT_LIB does not exist: ${LYNXTRON_IMPORT_LIB_PATH}")
+    endif()
+
+    set(${OUT_VAR} "${LYNXTRON_IMPORT_LIB_PATH}" PARENT_SCOPE)
+    return()
+  endif()
+
+  if(NOT DEFINED NODE_EXECUTABLE)
+    find_program(NODE_EXECUTABLE NAMES node)
+  endif()
+
+  if(NOT NODE_EXECUTABLE)
+    message(FATAL_ERROR "Unable to find node. Install Node.js before linking Lynxtron native libraries.")
+  endif()
+
+  if(NOT DEFINED LYNX_LIBRARY_PACKAGE_ROOT)
+    set(LYNX_LIBRARY_PACKAGE_ROOT "${CMAKE_CURRENT_SOURCE_DIR}")
+  endif()
+
+  execute_process(
+    COMMAND
+      "${NODE_EXECUTABLE}"
+      -e
+      "const path=require('node:path');const {createRequire}=require('node:module');try{const r=createRequire(path.join(process.argv[1],'package.json'));const p=r('@lynx-js/lynxtron/native-paths');process.stdout.write(p.importLibraryPath||'')}catch(e){process.exit(1)}"
+      "${LYNX_LIBRARY_HEADERS_PACKAGE_ROOT}"
+    WORKING_DIRECTORY "${LYNX_LIBRARY_PACKAGE_ROOT}"
+    RESULT_VARIABLE LYNXTRON_NATIVE_PATHS_RESULT
+    OUTPUT_VARIABLE LYNXTRON_IMPORT_LIB_FROM_PACKAGE
+    ERROR_QUIET
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+  )
+
+  if(LYNXTRON_NATIVE_PATHS_RESULT EQUAL 0 AND LYNXTRON_IMPORT_LIB_FROM_PACKAGE)
+    file(TO_CMAKE_PATH "${LYNXTRON_IMPORT_LIB_FROM_PACKAGE}" LYNXTRON_IMPORT_LIB_FROM_PACKAGE_PATH)
+    if(EXISTS "${LYNXTRON_IMPORT_LIB_FROM_PACKAGE_PATH}")
+      set(${OUT_VAR} "${LYNXTRON_IMPORT_LIB_FROM_PACKAGE_PATH}" PARENT_SCOPE)
+      return()
+    endif()
+  endif()
+
+  execute_process(
+    COMMAND
+      "${NODE_EXECUTABLE}"
+      -p
+      "const path=require('node:path');const {createRequire}=require('node:module');const r=createRequire(path.join(process.argv[1],'package.json'));let p;try{p=r.resolve('@lynx-js/lynxtron/package.json')}catch(e){p=r.resolve('@lynx-js/lynxtron')}path.dirname(p)"
+      "${LYNX_LIBRARY_HEADERS_PACKAGE_ROOT}"
+    WORKING_DIRECTORY "${LYNX_LIBRARY_PACKAGE_ROOT}"
+    RESULT_VARIABLE LYNXTRON_PACKAGE_ROOT_RESULT
+    OUTPUT_VARIABLE LYNXTRON_PACKAGE_ROOT
+    ERROR_VARIABLE LYNXTRON_PACKAGE_ROOT_ERROR
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+  )
+
+  if(NOT LYNXTRON_PACKAGE_ROOT_RESULT EQUAL 0 OR NOT LYNXTRON_PACKAGE_ROOT)
+    string(REPLACE "\n" " " LYNXTRON_PACKAGE_ROOT_ERROR "${LYNXTRON_PACKAGE_ROOT_ERROR}")
+    message(FATAL_ERROR "Unable to resolve @lynx-js/lynxtron. Run npm install first. ${LYNXTRON_PACKAGE_ROOT_ERROR}")
+  endif()
+
+  set(LYNXTRON_IMPORT_LIB_CANDIDATES
+    "${LYNXTRON_PACKAGE_ROOT}/dist/lynxtron.dll.lib"
+    "${LYNXTRON_PACKAGE_ROOT}/dist/win32/x64/lynxtron.dll.lib"
+    "${LYNXTRON_PACKAGE_ROOT}/dist/win32/x64/lynxtron/lynxtron.dll.lib"
+  )
+
+  foreach(LYNXTRON_IMPORT_LIB_CANDIDATE IN LISTS LYNXTRON_IMPORT_LIB_CANDIDATES)
+    if(EXISTS "${LYNXTRON_IMPORT_LIB_CANDIDATE}")
+      set(${OUT_VAR} "${LYNXTRON_IMPORT_LIB_CANDIDATE}" PARENT_SCOPE)
+      return()
+    endif()
+  endforeach()
+
+  message(FATAL_ERROR
+    "Unable to find lynxtron.dll.lib under @lynx-js/lynxtron. "
+    "Run npm install so @lynx-js/lynxtron downloads the Windows runtime, "
+    "or pass -DLYNXTRON_IMPORT_LIB=/absolute/path/to/lynxtron.dll.lib."
+  )
+endfunction()
+
+function(lynx_link_lynxtron_runtime TARGET_NAME)
+  if(NOT WIN32)
+    return()
+  endif()
+
+  lynx_resolve_lynxtron_import_library(LYNXTRON_RESOLVED_IMPORT_LIB)
+  target_link_libraries("${TARGET_NAME}" PRIVATE "${LYNXTRON_RESOLVED_IMPORT_LIB}")
+endfunction()

package/include/capi/lynx_env_capi.h

@@ -21,6 +21,7 @@ LYNX_CAPI_EXPORT const char* lynx_env_get_icu_data_path();
 
 // Lynx devtools
 typedef void (*lynx_env_open_card_callback)(void* user_data, const char* url);
+typedef void (*lynx_env_close_card_callback)(void* user_data);
 
 LYNX_CAPI_EXPORT void lynx_env_set_devtool_app_info(const char* name,
                                                     const char* value);
@@ -29,6 +30,8 @@ LYNX_CAPI_EXPORT int lynx_env_is_devtool_enabled();
 LYNX_CAPI_EXPORT int lynx_env_connect_devtool(const char* url);
 LYNX_CAPI_EXPORT void lynx_env_set_open_card_callback(
     lynx_env_open_card_callback callback, void* user_data);
+LYNX_CAPI_EXPORT void lynx_env_set_close_card_callback(
+    lynx_env_close_card_callback callback, void* user_data);
 // logbox
 LYNX_CAPI_EXPORT void lynx_env_enable_logbox(int enable);
 LYNX_CAPI_EXPORT int lynx_env_is_logbox_enabled();

package/include/lynx/platform/embedder/public/capi/lynx_env_capi.h

@@ -21,6 +21,7 @@ LYNX_CAPI_EXPORT const char* lynx_env_get_icu_data_path();
 
 // Lynx devtools
 typedef void (*lynx_env_open_card_callback)(void* user_data, const char* url);
+typedef void (*lynx_env_close_card_callback)(void* user_data);
 
 LYNX_CAPI_EXPORT void lynx_env_set_devtool_app_info(const char* name,
                                                     const char* value);
@@ -29,6 +30,8 @@ LYNX_CAPI_EXPORT int lynx_env_is_devtool_enabled();
 LYNX_CAPI_EXPORT int lynx_env_connect_devtool(const char* url);
 LYNX_CAPI_EXPORT void lynx_env_set_open_card_callback(
     lynx_env_open_card_callback callback, void* user_data);
+LYNX_CAPI_EXPORT void lynx_env_set_close_card_callback(
+    lynx_env_close_card_callback callback, void* user_data);
 // logbox
 LYNX_CAPI_EXPORT void lynx_env_enable_logbox(int enable);
 LYNX_CAPI_EXPORT int lynx_env_is_logbox_enabled();

package/include/lynx/platform/embedder/public/lynx_env.h

@@ -26,6 +26,8 @@ class LynxEnv {
   bool ConnectDevtool(const char* url);
   void SetOpenCardCallback(lynx_env_open_card_callback callback,
                            void* user_data);
+  void SetCloseCardCallback(lynx_env_close_card_callback callback,
+                            void* user_data);
   void SetLogboxEnabled(bool enable);
   bool IsLogboxEnabled();
   void RegisterNativeModule(const std::string& module_name,
@@ -78,6 +80,11 @@ inline void LynxEnv::SetOpenCardCallback(lynx_env_open_card_callback callback,
   lynx_env_set_open_card_callback(callback, user_data);
 }
 
+inline void LynxEnv::SetCloseCardCallback(lynx_env_close_card_callback callback,
+                                          void* user_data) {
+  lynx_env_set_close_card_callback(callback, user_data);
+}
+
 inline void LynxEnv::SetLogboxEnabled(bool enable) {
   lynx_env_enable_logbox(enable);
 }

package/include/lynx_env.h

@@ -26,6 +26,8 @@ class LynxEnv {
   bool ConnectDevtool(const char* url);
   void SetOpenCardCallback(lynx_env_open_card_callback callback,
                            void* user_data);
+  void SetCloseCardCallback(lynx_env_close_card_callback callback,
+                            void* user_data);
   void SetLogboxEnabled(bool enable);
   bool IsLogboxEnabled();
   void RegisterNativeModule(const std::string& module_name,
@@ -78,6 +80,11 @@ inline void LynxEnv::SetOpenCardCallback(lynx_env_open_card_callback callback,
   lynx_env_set_open_card_callback(callback, user_data);
 }
 
+inline void LynxEnv::SetCloseCardCallback(lynx_env_close_card_callback callback,
+                                          void* user_data) {
+  lynx_env_set_close_card_callback(callback, user_data);
+}
+
 inline void LynxEnv::SetLogboxEnabled(bool enable) {
   lynx_env_enable_logbox(enable);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lynx-js/lynx-library-headers",
   "author": "Lynxtron Authors",
-  "version": "0.0.1-alpha.4",
+  "version": "0.0.1-alpha.7",
   "type": "module",
   "description": "Lynx embedder C/C++ API and weak N-API headers for native libraries",
   "repository": {
@@ -21,8 +21,12 @@
   ],
   "files": [
     "include/**/*",
+    "cmake/**/*",
     "README.md"
   ],
+  "dependencies": {
+    "@lynx-js/lynxtron": "0.0.1-alpha.7"
+  },
   "engines": {
     "node": ">=18"
   }