nodejs / node-api-headers Goto Github PK

Create release v1.0.1 to bring the last update.

In microsoft/vcpkg#29743 we are confused as to what version we should use when listing the contents of this repo.

Let's take an example:

• Release: 0.0.5
• Node API version: 8
• From upstream: 19.8.1

See also: nodejs/node#46641 (comment)

NodeJS folks there seem to be suggesting "8" but if it would ever be distinguishable to a user for any reason to use a different upstream tag, that means the upstream tag needs to be in the version somehow...

Seems like after a PR to update is reviewed/landed we could automate publishing a new version.

New release to bring the last updates.

We should create a new release to bring the last update from the Node.js core repo. Node-API v9 has been shipped but for this repo and accordingly with https://github.com/nodejs/node-api-headers#versions the next versione will be v1.1.0.
Is it right @nodejs/node-api ?

according to nodejs/node#46641 (comment), the headers are a bit out of date. please let me know if this issue isn't valid.

We may need automation setups to help us reduce the labor works on synchronizing source files in this project that shared with the Node.js core repo.

In this issue I reported some correlated issues some of them pushed us to work on this repo:

• Calling napi_ functions from MinGW-compiled addon results in access violation nodejs/node#38782
• undefined reference linking errors during cross-compilation (using cmake-js) nodejs/node-addon-api#1021
• why the src/node_api.h and node_api_types.h head files were moved to the node repository nodejs/node-addon-api#855
• Provide definition files for stable API symbol exports nodejs/node-addon-api#720

My idea is to continue to work on documentation and then publish on npm.

Hey! Could you please trigger headers sync? This would trigger .def files generation which is required for microsoft/vcpkg#29743 @NickNaso

I used mingw64 to compile the node-api addon, and there was no problem executing it in nodejs, but there was an error prompt in Electron, I don't know how to solve it.

[5876:0518/221657.727:ERROR:crashpad_client_win.cc(844)] not connected

We should publish a new version as it been a while since that happened.

v6.node_api_symbols should probably extend v5.node_api_symbols instead of v5.js_native_api_symbols.

required for microsoft/vcpkg#29743

this can be done during sync-headers processing
https://github.com/nodejs/node-api-headers/blob/main/.github/workflows/sync-headers.yml

the following code may be used to generate .def file

// https://github.com/cmake-js/cmake-js/blob/e2452ee226490bc666d286ab0860aeb35fbbb035/lib/cMake.js#L293

const headers = require('.');

// Compile a Set of all the symbols that could be exported
const allSymbols = new Set()
for (const ver of Object.values(headers.symbols)) {
    for (const sym of ver.node_api_symbols) {
        allSymbols.add(sym)
    }
    for (const sym of ver.js_native_api_symbols) {
        allSymbols.add(sym)
    }
}

// Write a 'def' file for NODE.EXE
const allSymbolsArr = Array.from(allSymbols)
require('fs').writeFileSync("./node.def", 'NAME NODE.EXE\nEXPORTS\n' + allSymbolsArr.join('\n'))