npm package: @livesession/sdk
Description: Add a LiveSession script to your site even easier with our SDK
Author: LiveSession
Latest version: 1.1.4

[![Livesession SDK](https://circleci.com/gh/livesession/livesession-sdk.svg?style=svg)](https://circleci.com/gh/livesession/livesession-sdk/)

# Official LiveSession SDK

This small package let you install LiveSession script and configure it properly.

If you need you can use methods that were also provided in this SDK.

## Usage

`npm i @livesession/sdk` or `yarn add @livesession/sdk`

Next, you should initialize the SDK on your website like in this example:

```javascript
import ls from "@livesession/sdk";

// init a script, trackID is required
ls.init("YOUR TRACKID", options, sdkOptions);
```

After LiveSession is inited, you can start recording session using method `newPageView()`

**Initialization example with enabled recording**

```javascript
ls.init("123456789", { keystrokes: true, rootHostname: ".mypage.com" });
ls.newPageView();
// or with devMode on
ls.init(
  "1234.56789",
  { rootHostname: ".mypage.com" },
  {
    devMode: true, // process.env.NODE_ENV === "development"
  }
);
ls.newPageView();
```

**Custom events**

```javascript
ls.track("User Subscribed", {
  plan: "premium",
  seats: 1,
  total: 255.50,
  isPatron: true
});
```

## React usage

```javascript
ls.init("YOUR-TRACK-ID", options, sdkOptions);
ls.newPageView();
ReactDOM.render(<App />, document.getElementById("root"));
```

## Angular usage

Implementation is created thanks to [@SkowyrnyMG](https://github.com/SkowyrnyMG)

1. Import SDK into your main app component

2. Import `OnInit` from `@angular/core`

3. Implement `OnInit` and call LiveSession init method in `ngOnInit` function, and start recording

```javascript
// app.component.ts
import ls from '@livesession/sdk'

export class AppComponent implemets OnInit {
    ngOnInit(){
        ls.init("YOUR_TRACK_ID");
        ls.newPageView();
    }
}
```

For more about initializing script check out our [guide](https://developers.livesession.io/javascript-api/configuration/)

## sdkOptions

As a third argument to init method you can pass sdkOptions object, here are all available variables:

| Variable | Parameter | Default | Info                                              |
| -------- | --------- | ------- | ------------------------------------------------- |
| devMode  | bool      | false   | Log methods into console instead of calling their |
| scriptURL  | string      | https://cdn.livesession.io/track.js   | Link to LiveSession tracking code, useful if you want to use a specific version of code|

**Example**

```javascript
ls.init("exampleID", null, { devMode: true });
```

## API

If you initialized script, you can simply customize it with following functions:

| Function          | Parameter                    | Default           | Allowed                                        |
| ----------------- | ---------------------------- | ----------------- | -----------------------------------------------|
| init              | trackID, options, sdkOptions | null, null, false | string(required), object, object               |
| getSessionURL     | callback(url, isNewSession)  | null              | void(string, bool)                             |
| identify          | data                         | null              | object                                         |
| invalidateSession | -                            | null              | -                                              |
| newPageView       | options                      | null              | object                                         |
| setOptions        | options                      | null              | object                                         |
| setCustomParams   | data                         | null              | object                                         |
| off               | -                            | null              | -                                              |
| optOut            | -                            | false             | -                                              |
| debug             | -                            | false             | -                                              |
| track             | event, properties            | null, null        | string(required), object                       |
| log               | logLevel, data               | "log", null       | string("log", "info", "warn", "error"), object |

If out want to learn more about all methods, go to our [developers page](https://developers.livesession.io/javascript-api/methods/)

## Types

### logLevel supported

| Level    | Description                                                                        |
| -------- |----------------------------------------------------------------------------------- |
| "log"    |  Object will be logged as log                                                      |
| "info"   |  Object will be logged as info                                                     |
| "warn"   |  Object will be logged as warn                                                     |
| "error"  |  Object will be logged as error                                                    |



## Contributing

We're always open to work with our community. Let us know if you have ideas for new features or suggestions. Pull requests for bug fixes are also welcome!

## Changelog

This package currently support `v.1.4.0` of API, you can find more informations about API changelog [here](https://developers.livesession.io/getting-started/changelog/)

## License

[MIT](https://github.com/livesession/livesession-sdk/blob/master/LICENSE)