Generate TypeScript definition file for the ClpFfiJs module. (y-scope#4)

Author: junhaoliao

CMakeLists.txt

@@ -71,7 +71,7 @@ FetchContent_MakeAvailable(Boost)
 message("Boost sources successfully fetched into ${boost_SOURCE_DIR}")
 
 set(CLP_FFI_JS_BIN_NAME
-    "ClpFfijs"
+    "ClpFfiJs"
     CACHE STRING
     "Binary name for the generated .js and .wasm files."
 )
@@ -101,6 +101,7 @@ target_link_options(
         -sEXPORT_ES6
         -sMODULARIZE
         -sWASM_BIGINT
+        --emit-tsd ${CLP_FFI_JS_BIN_NAME}.d.ts
 )
 target_link_libraries(${CLP_FFI_JS_BIN_NAME} PRIVATE embind)
 

Taskfile.yml

@@ -47,7 +47,7 @@ tasks:
       - "mkdir -p '{{.OUTPUT_DIR}}'"
       - |-
         cmake -S "{{.ROOT_DIR}}" -B "{{.OUTPUT_DIR}}" -G "Unix Makefiles"
-        cmake --build "{{.OUTPUT_DIR}}" --parallel --target ClpFfijs
+        cmake --build "{{.OUTPUT_DIR}}" --parallel --target ClpFfiJs
       # This command must be last
       - task: "utils:compute-checksum"
         vars:
@@ -73,6 +73,9 @@ tasks:
         cd "{{.G_EMSDK_DIR}}"
         ./emsdk install latest
         ./emsdk activate latest
+      - |-
+        cd "{{.G_EMSDK_DIR}}/upstream/emscripten"
+        PATH=$(echo {{.G_EMSDK_DIR}}/node/*/bin):$PATH npm install
       # This command must be last
       - task: "utils:compute-checksum"
         vars:

src/clp_ffi_js/ir/StreamReader.cpp

@@ -32,7 +32,7 @@ using namespace std::literals::string_literals;
 using clp::ir::four_byte_encoded_variable_t;
 
 namespace clp_ffi_js::ir {
-auto StreamReader::create(emscripten::val const& data_array) -> StreamReader {
+auto StreamReader::create(DataArrayTsType const& data_array) -> StreamReader {
     auto const length{data_array["length"].as<size_t>()};
     SPDLOG_INFO("StreamReader::create: got buffer of length={}", length);
 
@@ -139,9 +139,9 @@ auto StreamReader::deserialize_range(size_t begin_idx, size_t end_idx) -> size_t
     return m_encoded_log_events.size();
 }
 
-auto StreamReader::decode_range(size_t begin_idx, size_t end_idx) const -> emscripten::val {
+auto StreamReader::decode_range(size_t begin_idx, size_t end_idx) const -> DecodedResultsTsType {
     if (m_encoded_log_events.size() < end_idx || begin_idx >= end_idx) {
-        return emscripten::val::null();
+        return DecodedResultsTsType(emscripten::val::null());
     }
 
     std::span const log_events_span{
@@ -192,7 +192,7 @@ auto StreamReader::decode_range(size_t begin_idx, size_t end_idx) const -> emscr
         ++log_num;
     }
 
-    return results;
+    return DecodedResultsTsType(results);
 }
 
 StreamReader::StreamReader(
@@ -207,6 +207,10 @@ StreamReader::StreamReader(
 
 namespace {
 EMSCRIPTEN_BINDINGS(ClpIrStreamReader) {
+    emscripten::register_type<clp_ffi_js::ir::DataArrayTsType>("Uint8Array");
+    emscripten::register_type<clp_ffi_js::ir::DecodedResultsTsType>(
+            "Array<[string, number, number, number]>"
+    );
     emscripten::class_<clp_ffi_js::ir::StreamReader>("ClpIrStreamReader")
             .constructor(
                     &clp_ffi_js::ir::StreamReader::create,

src/clp_ffi_js/ir/StreamReader.hpp

@@ -14,6 +14,9 @@
 #include <clp_ffi_js/ir/StreamReaderDataContext.hpp>
 
 namespace clp_ffi_js::ir {
+EMSCRIPTEN_DECLARE_VAL_TYPE(DataArrayTsType);
+EMSCRIPTEN_DECLARE_VAL_TYPE(DecodedResultsTsType);
+
 /**
  * Class to deserialize and decode Zstandard-compressed CLP IR streams as well as format decoded
  * log events.
@@ -27,7 +30,7 @@ class StreamReader {
      * @return The created instance.
      * @throw ClpFfiJsException if any error occurs.
      */
-    [[nodiscard]] static auto create(emscripten::val const& data_array) -> StreamReader;
+    [[nodiscard]] static auto create(DataArrayTsType const& data_array) -> StreamReader;
 
     // Destructor
     ~StreamReader() = default;
@@ -72,7 +75,7 @@ class StreamReader {
      * @return null if any log event in the range doesn't exist (e.g., the range exceeds the number
      * of log events in the file).
      */
-    [[nodiscard]] auto decode_range(size_t begin_idx, size_t end_idx) const -> emscripten::val;
+    [[nodiscard]] auto decode_range(size_t begin_idx, size_t end_idx) const -> DecodedResultsTsType;
 
 private:
     // Constructor