51Degrees Node.js

Node.js packages for Device Detection, IP Intelligence and Location

This repository holds the 51Degrees Node.js packages: the Pipeline API, Device Detection, IP Intelligence and Location. Each package is still published to npm under its own name.

Product	Read first	Documentation
Pipeline API	pipeline/readme.md	Node.js
Device Detection	device-detection/readme.md	Node.js
IP Intelligence	ip-intelligence/readme.md	Node.js
Location	location/README.md	Node.js

What is where

Path	Contents
pipeline	The Pipeline API packages, fiftyone.pipeline.*
device-detection	The Device Detection packages, fiftyone.devicedetection*
ip-intelligence	The IP Intelligence packages, fiftyone.ipintelligence*
location	The fiftyone.geolocation package
cxx	Submodule of 51degrees-cxx, with the C and C++ code and the data file submodules
ci	The scripts the shared 51Degrees CI workflows call

Getting the code

git clone --recurse-submodules https://github.com/51Degrees/51degrees-node.git
cd 51degrees-node
npm install

npm install links every package to the others in this repository through npm workspaces, so a change to one package is seen by the rest straight away.

The free Device Detection Lite data file in cxx/device-detection-data is stored with Git LFS. Run git lfs pull in that folder to fetch it.

Building the native modules

The on-premise packages need a native module, built with node-gyp. The configuration is stored as binding.51d so that npm install does not start a build for cloud users. In device-detection/fiftyone.devicedetection.onpremise or ip-intelligence/fiftyone.ipintelligence.onpremise, run:

cp binding.51d binding.gyp
node-gyp rebuild

Then copy build/Release/<module>.node to build/<module>-<platform>-<arch>-<node major version>.node, for example build/FiftyOneDeviceDetectionHashV4-darwin-arm64-24.node.

Tests

From the repository root:

npm run unit-test
npm run integration-test
npm run lint
npm run tsc

The tests that use the cloud need a resource key, which is read from the _51DEGREES_RESOURCE_KEY environment variable. See each folder's readme for the keys and data files its tests use.

Regenerating the SWIG wrappers

The wrappers are generated and must not be edited by hand. Use the node-24-holder-this branch of the 51Degrees fork of SWIG, and run:

cd device-detection/fiftyone.devicedetection.onpremise
swig -c++ -javascript -node hash_node.i
cd ../../ip-intelligence/fiftyone.ipintelligence.onpremise
swig -c++ -javascript -node ipi_node.i

History

The repositories pipeline-node, device-detection-node and location-node, and the one the IP Intelligence packages came from, were brought in with git subtree add, without --squash, so commit SHAs match the originals. Use git log --follow to trace a file back through the import.

Licence

European Union Public Licence v1.2