# @zanichelli/zanichelli-lrs-client

> Zanichelli LRS Client Library

Latest version **1.6.0** (published 2026-07-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zanichelli/zanichelli-lrs-client
pnpm add @zanichelli/zanichelli-lrs-client
yarn add @zanichelli/zanichelli-lrs-client
bun add @zanichelli/zanichelli-lrs-client
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2026-07-21 |
| First published | 2024-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 38.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | alessandrodolci, amalferpoma, ooga9k, edocava, a-sartori-wt, mikelina, nitroin, saldomik, vpasquino, dariosacco, paolofrancesco-marino, gretalucchina, f.santi, nicolo.carpignoli, leonardogiaconemondora, davideda, francescochiapella, alessandramartera, cmalvispx, developers_zanichelli, veronica.van, veronicavannini, alessandro_zuddas, alicegambdevs, lorenzoemanuele, attraverso, nliggeri |

## Links

- npm: https://www.npmjs.com/package/@zanichelli/zanichelli-lrs-client
- npm.io page: https://npm.io/package/@zanichelli/zanichelli-lrs-client

## Recent versions

- 1.6.0 (latest) — 2026-07-21
- 1.5.1-rc (1.5.1-rc) — 2026-07-03
- 1.3.0-rc (1.3.0-rc) — 2025-10-03
- 1.2.0-rc (beacon) — 2025-08-01
- 1.5.0 — 2026-05-21
- 1.4.0 — 2025-10-06
- 1.4.0-rc — 2025-10-03
- 1.3.0 — 2025-10-03
- 1.2.0 — 2025-08-01
- 1.1.0 — 2025-02-18
- 1.0.0 — 2024-03-05
- 0.0.2 — 2024-01-23
- 0.0.1 — 2024-01-11

## README

![Zanichelli logo](https://www.zanichelli.it/static/zanichelli/templates/zanichelli/_template_style/images/logo-print.png)

# Zanichelli LRS Client Library

This library exposes a client that allows statements to be sent to Zanichelli's
Learning Records Store in a predefined format

Example of a sent statement

```json
{
  "lrs_id": "6c4c289a8062c07ed758ea53c",
  "client_id": "98b5ad57-d547-416c-9429-5671e325366f",
  "statement": {
    "verb": {
      "id": "https://api.zanichelli.it/xapi/verbs/closed"
    },
    "context": {
      "platform": "adv",
      "extensions": {
        "https://api.zanichelli.it/xapi/keys/referer/id": "1"
      },
      "contextActivities": {
        "parent": [
          {
            "id": "http://info.zanichelli.it:3333"
          }
        ]
      }
    },
    "object": {
      "objectType": "Activity",
      "id": "https://info.zanichelli.it:3333",
      "definition": {
        "extensions": {
          "https://api.zanichelli.it/xapi/doNotShowAgain": false
        }
      }
    },
    "actor": {
      "objectType": "Agent",
      "account": {
        "homePage": "https://adv.zanichelli.it",
        "name": "anonymous"
      }
    },
    "timestamp": "2024-01-11T10:13:48.375000+00:00",
    "version": "1.0.0",
    "authority": {
      "name": "Zanichelli",
      "mbox": "mailto:info@Zanichelli.it"
    },
    "stored": "2024-01-11T10:13:48.858909+00:00",
    "id": "1ca5051a-b06a-11ee-906e-0242ac110002"
  }
}
```

## Installation (if you still need)

Download the package running this command:

```bash
yarn add @zanichelli/zanichelli-lrs-client
```

or import it in your html using Unpkg:

```html
<script
  type="module"
  src="https://cdn.jsdelivr.net/npm/@zanichelli/zanichelli-lrs-client/dist/index.js"
></script>
```

## Release Procedure

```bash
yarn release
```

## Symlink Local Development

```bash
yarn link
```

In the destination project folder run

```bash
yarn link @zanichelli/zanichelli-lrs-client
```

## Usage

It is recommended to create a utility file where to import the client and
instantiate it

```javascript
import { LrsClient } from "@zanichelli/zanichelli-lrs-client";

export const client = new LrsClient("environment", "platform", "homepage", {
  username: LRS_USERNAME,
  password: LRS_PASSWORD,
});
```

You must set the Lrs environment (`test` or `prod`) to be called and the
specific credentials of the application that is sending the statements

In order to send the statements a send method is provided:

```javascript
client.send(arg: StatementParams)
```

```javascript
interface StatementParams {
	verb: string;
	actor: ActorParams;
	context?: ContextParams;
	object: ObjectParams;
	authority?: AuthorityParams;
	result?: ResultParams;
}
```

---
_Source: https://npm.io/package/@zanichelli/zanichelli-lrs-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._