Installation

Install the Simplr SDK in your JavaScript or TypeScript project.

Requirements

• Node.js 18+ or modern browser
• TypeScript 4.7+ (optional)

Install

bun

bun add @simplr-ai/js

npm

npm install @simplr-ai/js

yarn

yarn add @simplr-ai/js

pnpm

pnpm add @simplr-ai/js

Import

ES Modules

import SimplrFraud from '@simplr-ai/js';

CommonJS

const { SimplrFraud } = require('@simplr-ai/js');

CDN

<script src="https://cdn.simplr.so/sdk/v1/simplr-fraud.min.js"></script>

Submodule imports

// React hooks and components
import { SimplrFraudProvider, useSimplrFraud } from '@simplr-ai/js/react';

// RUM only
import { SimplrRUM } from '@simplr-ai/js/rum';

Verify installation

import SimplrFraud from '@simplr-ai/js';

const simplr = new SimplrFraud();
await simplr.initialize();

const signals = await simplr.collect();
console.log('Fingerprint:', signals.device.fingerprint);

Framework guides

Vite

Works out of the box. No configuration needed.

Next.js

The SDK requires browser APIs. Use dynamic imports for SSR:

import dynamic from 'next/dynamic';

const SignupForm = dynamic(() => import('../components/SignupForm'), {
  ssr: false
});

Webpack

Works out of the box. No configuration needed.

Troubleshooting

Error	Solution
SimplrFraud is not a constructor	Use default import: import SimplrFraud from '@simplr-ai/js'
window is not defined	Use dynamic imports for SSR (see Next.js guide above)
TypeScript errors	Set "moduleResolution": "bundler" in tsconfig.json