@danetix/sentinel 1.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2026 Danetix. All rights reserved.
+
+This software is proprietary and confidential. Unauthorized copying,
+modification, distribution, or use of this software, in whole or in part,
+is strictly prohibited without the express written permission of Danetix.
+
+For licensing inquiries, contact: info@danetix.com

package/README.md

@@ -0,0 +1,217 @@
+# @danetix/sentinel
+
+Device intelligence SDK by [Danetix](https://danetix.com). Collects 155+ browser signals for device identification, bot detection, and anti-tamper analysis.
+
+## Features
+
+- **155+ browser signals** — canvas, audio, WebGL, WebGPU, fonts, and more
+- **Bot detection** — headless browsers, automation tools, CDP, Playwright, Puppeteer
+- **Anti-tamper** — proxy detection, descriptor integrity, prototype chain validation
+- **Anti-detect browser detection** — Multilogin, GoLogin, AdsPower
+- **Self-contained** — zero runtime dependencies, ~60KB gzipped
+- **All formats** — IIFE, ESM, CJS, UMD
+
+## Quick Start
+
+```html
+<script type="module">
+  const sentinel = import('https://your-domain.com/stl.esm.min.js')
+    .then(S => S.start({
+      apiKey: 'YOUR_API_KEY',
+      endpoint: 'https://your-domain.com/ingest'
+    }))
+
+  sentinel
+    .then(s => s.get())
+    .then(result => {
+      console.log(result.requestId)
+      console.log(result.deviceId)
+    })
+</script>
+```
+
+## Installation
+
+```bash
+npm install @danetix/sentinel
+# or
+pnpm add @danetix/sentinel
+# or
+yarn add @danetix/sentinel
+```
+
+## Usage
+
+### ESM (recommended)
+
+```js
+import { start } from '@danetix/sentinel'
+
+const sentinel = start({
+  apiKey: 'YOUR_API_KEY',
+  endpoint: 'https://your-domain.com/ingest',
+  cache: { ttl: 300 }   // optional: cache results for 5 minutes
+})
+
+const result = await sentinel.get()
+console.log(result.deviceId)
+```
+
+### Script Tag
+
+```html
+<script src="https://your-domain.com/stl.min.js"></script>
+<script>
+  var sentinel = Sentinel.start({
+    apiKey: 'YOUR_API_KEY',
+    endpoint: '/ingest'
+  })
+
+  sentinel.get().then(function(result) {
+    console.log(result.deviceId)
+  })
+</script>
+```
+
+### SPA (Single Page Application)
+
+```js
+const sentinel = start({
+  apiKey: 'YOUR_API_KEY',
+  endpoint: '/ingest',
+  cache: { ttl: 300, location: 'sessionStorage' }
+})
+
+// Call on each route change
+router.afterEach(() => {
+  sentinel.get()
+})
+
+// Force fresh request
+sentinel.get({ ignoreCache: true })
+
+// Clear cache manually
+sentinel.clearCache()
+```
+
+## API
+
+### `start(options): SentinelInstance`
+
+Initialize the SDK. Starts signal collection immediately.
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiKey` | `string` | *required* | Workspace API key |
+| `endpoint` | `string` | *required* | Ingest endpoint URL |
+| `cache` | `CacheOptions` | — | Enable result caching |
+| `cache.ttl` | `number` | `0` | Cache TTL in seconds |
+| `cache.location` | `'memory' \| 'localStorage' \| 'sessionStorage'` | `'memory'` | Cache storage |
+| `debug` | `boolean` | `false` | Enable debug logging |
+| `proxyDetection` | `'light' \| 'high'` | `'high'` | Anti-detect detection mode |
+
+### `SentinelInstance.get(options?): Promise<CaptureResult>`
+
+Capture device signals, send to endpoint, return result.
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `ignoreCache` | `boolean` | Skip cache, force fresh request |
+| `linkedId` | `string` | Custom identifier (user login, order ID) |
+| `tag` | `Record<string, unknown>` | Custom metadata |
+
+### `SentinelInstance.clearCache(): void`
+
+Clear cached result. Next `.get()` will make a fresh request.
+
+### `CaptureResult`
+
+```ts
+{
+  requestId: string       // Unique event ID
+  deviceId: string        // Stable device identifier
+  signedDeviceToken: string  // Signed token for persistence
+}
+```
+
+## Browser Support
+
+| Browser | Version |
+|---------|---------|
+| Chrome | 80+ |
+| Firefox | 113+ |
+| Safari | 16.4+ |
+| Edge | 80+ |
+| Samsung Internet | 14+ |
+
+## Bundle Sizes
+
+| Format | File | Size | Gzipped |
+|--------|------|------|---------|
+| IIFE | `stl.min.js` | 190 KB | ~60 KB |
+| ESM | `stl.esm.min.js` | 196 KB | ~62 KB |
+| CJS | `stl.cjs.min.js` | 196 KB | ~62 KB |
+| UMD | `stl.umd.min.js` | 190 KB | ~60 KB |
+
+## License
+
+Proprietary. See LICENSE for details.
+
+---
+
+# @danetix/sentinel (RU)
+
+SDK для анализа устройств от [Danetix](https://danetix.com). Собирает 155+ сигналов браузера для идентификации устройств, обнаружения ботов и защиты от подмены.
+
+## Быстрый старт
+
+```html
+<script type="module">
+  const sentinel = import('https://your-domain.com/stl.esm.min.js')
+    .then(S => S.start({
+      apiKey: 'ВАШ_API_КЛЮЧ',
+      endpoint: 'https://your-domain.com/ingest'
+    }))
+
+  sentinel
+    .then(s => s.get())
+    .then(result => {
+      console.log(result.requestId)
+      console.log(result.deviceId)
+    })
+</script>
+```
+
+## Установка
+
+```bash
+npm install @danetix/sentinel
+```
+
+## Использование в SPA
+
+```js
+import { start } from '@danetix/sentinel'
+
+const sentinel = start({
+  apiKey: 'ВАШ_API_КЛЮЧ',
+  endpoint: '/ingest',
+  cache: { ttl: 300, location: 'sessionStorage' }
+})
+
+// Вызывать при каждой смене роута
+router.afterEach(() => sentinel.get())
+```
+
+## Опции кеширования
+
+| Опция | Тип | Описание |
+|-------|-----|----------|
+| `ttl` | `number` | Время жизни кеша в секундах |
+| `location` | `'memory' \| 'localStorage' \| 'sessionStorage'` | Где хранить кеш |
+
+Без `cache` — каждый `.get()` отправляет запрос на сервер.
+
+## Лицензия
+
+Проприетарная. Подробности в файле LICENSE.