@sphereon/ssi-sdk.anomaly-detection/README.md

<!--suppress HtmlDeprecatedAttribute -->
<h1 align="center">
  <br>
  <a href="https://www.sphereon.com"><img src="https://sphereon.com/content/themes/sphereon/assets/img/logo.svg" alt="Sphereon" width="400"></a>
  <br>Anomaly Detection (Typescript) 
  <br>
</h1>

---

**Warning: This package still is in very early development. Breaking changes without notice will happen at this point!**

---

A Sphereon anomaly detection plugin. This plugin identifies the location of an URL

## Available functions

- lookupLocation

## Usage

### Adding the plugin to an agent:

```typescript
import { AnomalyDetection } from '@sphereon/ssi-sdk.anomaly-detection'

const agent = createAgent<IAnomalyDetection>({
  plugins: [
    new AnomalyDetection({
      geoIpDBPath: './GeoLite2-Country.mmdb',
    }),
  ],
})
```

### Lookup a location:

```typescript
const result = await agent.lookupLocation({
  ipOrHostname: '2001:0000:130F:0000:0000:09C0:876A:130B',
})
```

## Installation

```shell
yarn add @sphereon/ssi-sdk.anomaly-detection
```

## Build

```shell
yarn build
```