[JS OV] Node.js API

.github/dependency_review.yml

@@ -5,6 +5,11 @@ allow-licenses:
   - 'BSD-2-Clause AND BSD-3-Clause'
   - 'MIT'
   - 'Apache-2.0'
+  - 'ISC'
+  - 'Apache-2.0 AND MIT'
+  - 'BlueOak-1.0.0'
+  - '0BSD'
+  - 'Python-2.0'
 fail-on-scopes:
   - 'runtime'
   - 'development'

cmake/developer_package/packaging/archive.cmake

@@ -85,6 +85,8 @@ macro(ov_define_component_include_rules)
     set(OV_CPACK_COMP_PYTHON_OPENVINO_PACKAGE_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     unset(OV_CPACK_COMP_PYTHON_WHEELS_EXCLUDE_ALL)
     unset(OV_CPACK_COMP_OPENVINO_REQ_FILES_EXCLUDE_ALL)
+    # nodejs
+    set(OV_CPACK_COMP_NPM_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # tools
     set(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     unset(OV_CPACK_COMP_DEPLOYMENT_MANAGER_EXCLUDE_ALL)

cmake/developer_package/packaging/common-libraries.cmake

@@ -101,6 +101,8 @@ macro(ov_define_component_include_rules)
     set(OV_CPACK_COMP_PYTHON_WHEELS_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # we don't need requirements.txt in package, because dependencies are installed by packages managers like conda
     set(OV_CPACK_COMP_OPENVINO_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # nodejs
+    set(OV_CPACK_COMP_NPM_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # tools
     set(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     set(OV_CPACK_COMP_DEPLOYMENT_MANAGER_EXCLUDE_ALL EXCLUDE_FROM_ALL)

cmake/developer_package/packaging/debian/debian.cmake

@@ -106,6 +106,8 @@ macro(ov_define_component_include_rules)
     set(OV_CPACK_COMP_PYTHON_WHEELS_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # because numpy is installed by apt
     set(OV_CPACK_COMP_OPENVINO_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # nodejs
+    set(OV_CPACK_COMP_NPM_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # tools
     set(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     set(OV_CPACK_COMP_DEPLOYMENT_MANAGER_EXCLUDE_ALL EXCLUDE_FROM_ALL)

cmake/developer_package/packaging/npm.cmake

@@ -0,0 +1,105 @@
+# Copyright (C) 2018-2023 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+#
+
+include(GNUInstallDirs)
+
+# We have to specify RPATH, all runtime libs are in one dir 
+set(CMAKE_SKIP_INSTALL_RPATH OFF)
+
+#
+# ov_npm_cpack_set_dirs()
+#
+# Set directories for cpack
+#
+macro(ov_npm_cpack_set_dirs)
+    set(OV_CPACK_INCLUDEDIR .)
+    set(OV_CPACK_IE_CMAKEDIR .)
+    set(OV_CPACK_NGRAPH_CMAKEDIR .)
+    set(OV_CPACK_OPENVINO_CMAKEDIR .)
+    set(OV_CPACK_DOCDIR .)
+    set(OV_CPACK_LICENSESDIR .)
+    set(OV_CPACK_SAMPLESDIR .)
+    set(OV_CPACK_WHEELSDIR .)
+    set(OV_CPACK_TOOLSDIR .)
+    set(OV_CPACK_DEVREQDIR .)
+    set(OV_CPACK_PYTHONDIR .)
+
+    if(WIN32)
+        set(OV_CPACK_LIBRARYDIR .)
+        set(OV_CPACK_RUNTIMEDIR .)
+        set(OV_CPACK_ARCHIVEDIR .)
+    elseif(APPLE)
+        set(OV_CPACK_LIBRARYDIR .)
+        set(OV_CPACK_RUNTIMEDIR .)
+        set(OV_CPACK_ARCHIVEDIR .)
+    else()
+        set(OV_CPACK_LIBRARYDIR .)
+        set(OV_CPACK_RUNTIMEDIR .)
+        set(OV_CPACK_ARCHIVEDIR .)
+    endif()
+
+    set(OV_CPACK_LIBRARYDIR .)
+    set(OV_CPACK_ARCHIVEDIR .)
+    set(OV_CPACK_PLUGINSDIR .)
+    set(OV_CPACK_IE_CMAKEDIR .)
+    set(OV_CPACK_NGRAPH_CMAKEDIR .)
+    set(OV_CPACK_OPENVINO_CMAKEDIR .)
+    set(OV_CPACK_DOCDIR .)
+    set(OV_CPACK_LICENSESDIR licenses)
+    set(OV_CPACK_PYTHONDIR .)
+
+    # non-native stuff
+    set(OV_CPACK_SHAREDIR .)
+    set(OV_CPACK_SAMPLESDIR .)
+    set(OV_CPACK_DEVREQDIR .)
+    unset(OV_CPACK_SHAREDIR)
+
+    # skipped during debian packaging
+    set(OV_CPACK_WHEELSDIR .)
+endmacro()
+
+ov_npm_cpack_set_dirs()
+
+#
+# Override include / exclude rules for components
+# This is required to exclude some files from installation
+# (e.g. npm package requires only C++ Core component)
+#
+
+macro(ov_define_component_include_rules)
+    # core components
+    unset(OV_CPACK_COMP_CORE_EXCLUDE_ALL)
+    set(OV_CPACK_COMP_CORE_C_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_CORE_DEV_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_CORE_C_DEV_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # tbb
+    unset(OV_CPACK_COMP_TBB_EXCLUDE_ALL)
+    set(OV_CPACK_COMP_TBB_DEV_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # licensing
+    unset(OV_CPACK_COMP_LICENSING_EXCLUDE_ALL)
+    # samples
+    set(OV_CPACK_COMP_CPP_SAMPLES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_C_SAMPLES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_PYTHON_SAMPLES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # python
+    set(OV_CPACK_COMP_PYTHON_OPENVINO_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_BENCHMARK_APP_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_OVC_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_PYTHON_OPENVINO_PACKAGE_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_PYTHON_WHEELS_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_OPENVINO_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # nodejs
+    unset(OV_CPACK_COMP_NPM_EXCLUDE_ALL)
+    # tools
+    set(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_DEPLOYMENT_MANAGER_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # scripts
+    set(OV_CPACK_COMP_INSTALL_DEPENDENCIES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    set(OV_CPACK_COMP_SETUPVARS_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+endmacro()
+
+ov_define_component_include_rules()
+
+# New in version 3.18
+set(CPACK_ARCHIVE_THREADS 8)

cmake/developer_package/packaging/nsis.cmake

@@ -117,6 +117,8 @@ macro(ov_define_component_include_rules)
     set(OV_CPACK_COMP_PYTHON_WHEELS_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     set(OV_CPACK_COMP_PYTHON_OPENVINO_PACKAGE_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     unset(OV_CPACK_COMP_OPENVINO_REQ_FILES_EXCLUDE_ALL)
+    # nodejs
+    set(OV_CPACK_COMP_NPM_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # tools
     unset(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES_EXCLUDE_ALL)
     unset(OV_CPACK_COMP_DEPLOYMENT_MANAGER_EXCLUDE_ALL)

cmake/developer_package/packaging/packaging.cmake

@@ -41,10 +41,16 @@ endmacro()
 #
 function(ov_set_install_rpath TARGET_NAME lib_install_path)
     if(APPLE AND CPACK_GENERATOR MATCHES "^(7Z|TBZ2|TGZ|TXZ|TZ|TZST|ZIP)$" OR CPACK_GENERATOR STREQUAL "NPM")
+        if (APPLE)
+            set(RPATH_PREFIX "@loader_path")
+        else()
+            set(RPATH_PREFIX "$ORIGIN")
+        endif()
+
         unset(rpath_list)
         foreach(dependency_install_path IN LISTS ARGN)
             file(RELATIVE_PATH dependency_rpath "/${lib_install_path}" "/${dependency_install_path}")
-            set(dependency_rpath "@loader_path/${dependency_rpath}")
+            set(dependency_rpath "${RPATH_PREFIX}/${dependency_rpath}")
             list(APPEND rpath_list "${dependency_rpath}")
         endforeach()
 
@@ -139,6 +145,8 @@ macro(ov_define_component_names)
     set(OV_CPACK_COMP_PYTHON_OPENVINO_PACKAGE "pyopenvino_package")
     set(OV_CPACK_COMP_PYTHON_WHEELS "python_wheels")
     set(OV_CPACK_COMP_OPENVINO_REQ_FILES "openvino_req_files")
+    # nodejs
+    set(OV_CPACK_COMP_NPM "ov_node_addon")
     # tools
     set(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES "openvino_dev_req_files")
     set(OV_CPACK_COMP_DEPLOYMENT_MANAGER "deployment_manager")
@@ -179,6 +187,8 @@ elseif(CPACK_GENERATOR STREQUAL "RPM")
     include(packaging/rpm/rpm)
 elseif(CPACK_GENERATOR STREQUAL "NSIS")
     include(packaging/nsis)
+elseif(CPACK_GENERATOR STREQUAL "NPM")
+    include(packaging/npm)
 elseif(CPACK_GENERATOR MATCHES "^(CONDA-FORGE|BREW|CONAN|VCPKG)$")
     include(packaging/common-libraries)
 elseif(CPACK_GENERATOR MATCHES "^(7Z|TBZ2|TGZ|TXZ|TZ|TZST|ZIP)$")

cmake/developer_package/packaging/rpm/rpm.cmake

@@ -97,6 +97,8 @@ macro(ov_define_component_include_rules)
     set(OV_CPACK_COMP_PYTHON_WHEELS_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # because numpy is installed by rpm
     set(OV_CPACK_COMP_OPENVINO_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
+    # nodejs
+    set(OV_CPACK_COMP_NPM_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     # tools
     set(OV_CPACK_COMP_OPENVINO_DEV_REQ_FILES_EXCLUDE_ALL EXCLUDE_FROM_ALL)
     set(OV_CPACK_COMP_DEPLOYMENT_MANAGER_EXCLUDE_ALL EXCLUDE_FROM_ALL)

cmake/packaging/npm.cmake

@@ -0,0 +1,27 @@
+# Copyright (C) 2018-2023 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+#
+
+#
+# OpenVINO npm binaries, includes openvino:runtime, frontends, plugins, tbb
+#
+macro(ov_cpack_settings)
+    # fill a list of components which are part of conda
+    set(cpack_components_all ${CPACK_COMPONENTS_ALL})
+
+    unset(CPACK_COMPONENTS_ALL)
+    foreach(item IN LISTS cpack_components_all)
+        string(TOUPPER ${item} UPPER_COMP)
+        # filter out some components, which are not needed to be wrapped to npm package
+        if(NOT OV_CPACK_COMP_${UPPER_COMP}_EXCLUDE_ALL AND
+            # python is not required for npm package
+            NOT item MATCHES "^${OV_CPACK_COMP_PYTHON_OPENVINO_PACKAGE}_python.*")
+             list(APPEND CPACK_COMPONENTS_ALL ${item})
+        endif()
+    endforeach()
+    unset(cpack_components_all)
+    list(REMOVE_DUPLICATES CPACK_COMPONENTS_ALL)
+
+    # override generator
+    set(CPACK_GENERATOR "TGZ")
+endmacro()

cmake/packaging/packaging.cmake

@@ -4,6 +4,8 @@
 
 if(CPACK_GENERATOR STREQUAL "DEB")
     include("${OpenVINO_SOURCE_DIR}/cmake/packaging/debian.cmake")
+elseif(CPACK_GENERATOR STREQUAL "NPM")
+    include("${OpenVINO_SOURCE_DIR}/cmake/packaging/npm.cmake")
 elseif(CPACK_GENERATOR STREQUAL "RPM")
     include("${OpenVINO_SOURCE_DIR}/cmake/packaging/rpm.cmake")
 elseif(CPACK_GENERATOR MATCHES "^(CONDA-FORGE|BREW|CONAN|VCPKG)$")

samples/js/.gitignore

@@ -0,0 +1 @@
+/assets

samples/js/node/.eslintrc.js

@@ -0,0 +1,15 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 'latest'
+  },
+  env: {
+    node: true,
+    es6: true,
+  },
+  extends: [
+    'eslint:recommended',
+    '../../../src/bindings/js/.eslintrc-global.js',
+  ],
+  ignorePatterns: ['node_modules/', '.eslintrc.js'],
+  root: true,
+};

samples/js/node/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+hello_reshape_ssd/out.jpg

samples/js/node/README.md

@@ -0,0 +1,26 @@
+# OpenVINO™ JavaScript API examples of usage
+
+## Installation of openvinojs-node package
+From *openvino/src/bindings/js/node* run `npm i` to download OpenVINO™ runtime, install requirements, build bindings and compile TypeScript code to JavaScript
+
+On the *.nix systems run `source openvino/src/bindings/js/node/scripts/setupvars.sh` to add path to OpenVINO™ runtime libraries in `LD_LIBRARY_PATH` variable
+
+Note: Perform these steps also before running notebooks.
+
+## Samples
+  - hello_classification
+  - hello_reshape_ssd
+  - classification_sample_async
+
+## Notebooks
+
+Use [Node.js Notebooks (REPL)](https://marketplace.visualstudio.com/items?itemName=donjayamanne.typescript-notebook)
+VSCode extension to run these notebook samples
+
+Make sure that `LD_LIBRARY_PATH` variable contains path to OpenVINO runtime folder
+
+- ./notebooks
+  -   001-hello-world.nnb
+  -   003-hello-segmentation.nnb
+  -   004-hello-detection.nnb
+  -   213-question-answering.nnb

samples/js/node/classification_sample_async/README.md

@@ -0,0 +1,8 @@
+# Image Classification Async NodeJS Sample
+
+Models with only 1 input and output are supported.
+
+Run:
+`node classification_sample_async.js -m *path_to_model_file* -i *path_to_img1* -i *path_to_img2* -d AUTO`
+
+Other details see in /samples/python/classification_sample_async/README.md