Ginger JS

GingerJS is a JavaScript library designed for advanced device fingerprinting and behavioral analytics in single-page applications (SPAs). It provides robust capabilities for device identification and user behaviour monitoring, making it an essential tool for enhancing security systems and fraud prevention.

Table of Contents

• Installation
  • NPM Installation
• Implementation Guide
• Technical Overview
• Development Setup
  • Local Environment
  • Building
  • Testing
• License Information

Installation

NPM Installation

Install via NPM:

npm install @ginger-ai/ginger-js

Implementation Guide

NPM Implementation

import { GingerJsClient } from "@ginger-ai/ginger-js";

async function initializeGinger() {
  const gingerjs = new GingerJsClient({
    apikey: "your-api-key"
  });
  const response = await gingerjs.initialize();

  // Optional: Configure behavior tracking
  gingerjs.trackEvent({
    event_type: "login",
    request_id: response.request_id,
    track_fields: [
        { id: "username", ltm: true },
        { id: "password", ltm: true },
      ],,
  });

  const result = await gingerjs.submitEvent();
  return result;
}

Technical Overview

The library operates through a request session-based architecture:

1. Initialization: Generates a unique request_id for tracking purposes
2. Behavior Tracking (Optional):
   • Requires: event_type, request_id, and track_fields
   • Monitors specified input elements for user interaction
3. Data Submission: Returns a structured◊◊ response:

   {
     event_id: number,
     request_id: string,
     message: string
   }

Local Environment

npm install

Building

npm run build

Testing

npm test