fiftyone.devicedetection.onpremise

v4.4.165

Device detection on-premise services for the 51Degrees Pipeline API For more information about how to use this package see README

Latest version published 1 day ago

License: EUPL-1.2

NPM

GitHub

Package Health Score

73 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version			Vulnerabilities	License Risk
4.4.165	\|	12/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.4.162	\|	12/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.3.12	\|	03/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.2.3	\|	05/2021	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

EUPL-1.2

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (660)

GitHub Stars: 2
Forks: 4
Contributors: 20

Direct Usage Popularity

The npm package fiftyone.devicedetection.onpremise receives a total of 660 downloads a week. As such, we scored fiftyone.devicedetection.onpremise popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package fiftyone.devicedetection.onpremise, we found that it has been starred 2 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the fiftyone.devicedetection.onpremise repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like fiftyone.devicedetection.onpremise is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 1 day ago
Last Commit: 14 days ago

Further analysis of the maintenance status of fiftyone.devicedetection.onpremise based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that fiftyone.devicedetection.onpremise demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 6 Direct
Versions: 179
Install Size: 8.58 MB
Dist-tags: 1
# of Files: 32
Maintainers: 3
TS Typings: No

fiftyone.devicedetection.onpremise has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Node Device Detection On-Premise

Developer Documentation

Introduction

This project contains 51Degrees Device Detection engines that can be used with the Pipeline API.

The Pipeline is a generic web request intelligence and data processing solution with the ability to add a range of 51Degrees and/or custom plug ins (Engines)

This package - fiftyone.devicedetection.onpremise

This package provides a On-Premise implementation of Device Detection engine which makes use of a local data file. This includes a builder used to build a pipeline for On-Premise Device Detection engine.

This package requires the following additional packages:

fiftyone.devicedetection.shared - A Node.js module which contains shared functionality to build cloud and on-premise engines.

Installation

Using NPM call:

npm install fiftyone.devicedetection.onpremise

On-Premise

When running on-premise, a local Hash V4.1 data file is required.

Hash: A large binary file populated with User-Agent signatures allowing very fast detection speeds.

51Degrees provides multiple options, some of which support automatic updates through the Pipeline API.

If the module is installed directly from Git then the binaries are also required. These binaries are native module which contains the core engine of device detection. Below are the steps to build these binaries:

Pre-requisites

Install Node.js.
Install node-gyp by running.
- npm install node-gyp --global
Install C build tools:
- Windows:
  - You will need either Visual Studio 2019 or the C++ Build Tools installed.
    - Minimum platform toolset version is v142
    - Minimum Windows SDK version is 10.0.18362.0
- Linux/MacOS:
  - sudo apt-get install g++ make libatomic1
Pull git submodules:
- git submodule update --init --recursive

Build Steps

Navigate to fiftyone.devicedetection.onpremise
Rename the binding.51d to binding.gyp
Run npm install
- Alternatively this step can be replaced by the followings:
  - Create a folder named build.
  - Run node-gyp configure
  - Run node-gyp build
- Platform specific:
  - Windows
    - By default this will look for Visual Studio 2019 and a minimum Windows SDK version 10.0.18362.0.
    - This can be overwritten by include --msvs_version=[VS version] and --msvs_target_platform_version=[Windows SDK Version] as part of the npm install command.
      - NOTE: This is not recommended. Also, some time the latest SDK version is selected instead, as observed in environment with multiple SDK versions installed. Thus, only install the correct Visual Studio version and the minimum required Windows SDK version as recommended.
This will build the FiftyOneDeviceDetectionHashV4.node under build/Release folder.
Copy the FiftyOneDeviceDetectionHashV4.node to build directory (which is one level up) and rename it using the following convention.
- Windows:
  - FiftyOneDeviceDetectionHashV4-win32-[ Node version ].node
    - e.g. FiftyOneDeviceDetectionHashV4-win32-10.node for Node 10.
- Linux:
  - FiftyOneDeviceDetectionHashV4-linux-[ Node version ].node
    - e.g. FiftyOneDeviceDetectionHashV4-linux-10.node for Node 10.
- MacOS:
  - FiftyOneDeviceDetectionHashV4-darwin-[ Node version ].node
    - e.g. FiftyOneDeviceDetectionHashV4-darwin-10.node for Node 10.
- Please see the tested versions page for Node versions that we currently test against. The software may run fine against other versions, but extra caution should be applied.
- You can optionally clear up by removing all the build files and folders except for the *.node file that's been created.
- WARNING: npm install removes this copied file, so you will need to do the above steps again after running npm install

Examples

For details of how to run the examples, please refer to run examples. The tables below describe the examples that are available.

Example	Description
automaticupdates/dataFileSystemWatcher.js	How to configure automatic updates using the file system watcher to monitor for changes to the data file.
automaticupdates/updateOnStartUp.js	How to configure the Pipeline to automatically update the device detection data file on startup.
automaticupdates/updatePollingInterval.js	Ho to configure and verify the various automatic data file update settings.
gettingstarted-console	How to use the 51Degrees on-premise device detection API to determine details about a device based on its User-Agent and User-Agent Client Hints HTTP header values.
gettingstarted-web	How to use the 51Degrees Cloud service to determine details about a device as part of a simple web server.
matchmetrics-console	How to view metrics associated with the results of processing with a Device Detection engine.
metadata-console	How to access the meta-data that relates to the device detection algorithm.
offlineprocessing-console	How to process data for later viewing using a Device Detection Hash data file.
performance-console	How to configure the various performance options and run a simple performance test.
updatedatafile-console	This example illustrates various parameters that can be adjusted when using the on-premise device detection engine, and controls when a new data file is sought and when it is loaded by the device detection software.
useragentclienthints-web	This is now deprecated. Kept for testing purposes. Please see gettingstarted-web instead.

Tests

In this repository, there are tests for the examples. You will need to install jest to run them:

npm install jest --global

You will also need to install any required packages for the examples in the Examples section.

To run the tests, navigate to the module directory and execute:

npm test

Native code updates

Process for rebuilding SWIG interfaces following an update to the device detection cxx code (This is only intended to be run by 51Degrees developers internally):

Ensure Swig is installed.
1. At the time when this README was updated, the current stable version of Swig did not support new changes in Node 12 and above.
2. The Swig version being used is built from the following branch.
  1. https://github.com/yegorich/swig/tree/pr/new-node-fixes.
  2. There had been an active Pull Request created to merge the changes to the main Swig master branch.
  3. Once the Pull Request is completed, the consequent Swig releases should be used.
Update the device-detection-cxx submodule to reference the relevant commit.
From terminal, navigate to fiftyone.pipeline.devicedetection and run: a) swig -c++ -javascript -node hash_node.i
Commit changes to repository.
Run the 'Build Device Detection Binaries for Node.js' Azure CI Pipeline.
Copy the produced artifacts into the fiftyone.pipeline.devicedetection/build directory.
Commit changes to repository.

fiftyone.devicedetection.onpremise dependencies

fiftyone.devicedetection.shared fiftyone.pipeline.core fiftyone.pipeline.engines fiftyone.pipeline.engines.fiftyone js-yaml n-readlines

fiftyone.devicedetection.onpremise development dependencies

@types/jest @types/node jest jest-junit

FAQs

What is fiftyone.devicedetection.onpremise?

Device detection on-premise services for the 51Degrees Pipeline API. Visit Snyk Advisor to see a full health score report for fiftyone.devicedetection.onpremise, including popularity, security, maintenance & community analysis.

Is fiftyone.devicedetection.onpremise popular?

The npm package fiftyone.devicedetection.onpremise receives a total of 660 weekly downloads. As such, fiftyone.devicedetection.onpremise popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is fiftyone.devicedetection.onpremise well maintained?

We found that fiftyone.devicedetection.onpremise demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is fiftyone.devicedetection.onpremise safe to use?

The npm package fiftyone.devicedetection.onpremise was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 17:31 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP