@lessonkit/core 0.9.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -12
- package/dist/index.cjs +574 -12
- package/dist/index.d.cts +185 -20
- package/dist/index.d.ts +185 -20
- package/dist/index.js +546 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,13 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @lessonkit/core
|
|
2
2
|
|
|
3
|
-
[](https://github.com/eddiethedean/lessonkit/actions/workflows/ci.yml)
|
|
4
|
-
[](https://lessonkit.readthedocs.io/en/latest/)
|
|
5
3
|
[](https://www.npmjs.com/package/@lessonkit/core)
|
|
4
|
+
[](https://lessonkit.readthedocs.io/en/latest/reference/core.html)
|
|
6
5
|
[](https://github.com/eddiethedean/lessonkit/blob/main/LICENSE)
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
**Docs:** [Identity reference](https://lessonkit.readthedocs.io/en/latest/reference/identity.html) · [Telemetry reference](https://lessonkit.readthedocs.io/en/latest/reference/telemetry.html) · [Telemetry & xAPI guide](https://lessonkit.readthedocs.io/en/latest/guides/react-developers/telemetry-and-xapi.html)
|
|
7
|
+
Headless types, identity helpers, telemetry pipeline, and runtime primitives shared across LessonKit.
|
|
11
8
|
|
|
12
9
|
## Install
|
|
13
10
|
|
|
@@ -15,11 +12,33 @@ Core types and runtime primitives shared across LessonKit packages.
|
|
|
15
12
|
npm install @lessonkit/core
|
|
16
13
|
```
|
|
17
14
|
|
|
18
|
-
##
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
buildTelemetryEvent,
|
|
20
|
+
createLessonkitRuntime,
|
|
21
|
+
createTelemetryPipeline,
|
|
22
|
+
createPluginRegistry,
|
|
23
|
+
buildLessonkitUrn,
|
|
24
|
+
} from "@lessonkit/core";
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Exports
|
|
28
|
+
|
|
29
|
+
| Area | Key APIs |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| Identity | `validateId`, `slugifyId`, `buildLessonkitUrn` |
|
|
32
|
+
| Telemetry | `buildTelemetryEvent`, `createTrackingClient`, `createTelemetryPipeline` |
|
|
33
|
+
| Runtime | `createLessonkitRuntime`, progress and session helpers |
|
|
34
|
+
| Plugins | `createPluginRegistry`, `defineTelemetryPlugin`, `defineAssessmentPlugin` |
|
|
35
|
+
|
|
36
|
+
Machine-readable: `@lessonkit/core/telemetry-catalog.v1.json`, `identity-contract.v1.json`
|
|
37
|
+
|
|
38
|
+
## Docs
|
|
39
|
+
|
|
40
|
+
[Core reference](https://lessonkit.readthedocs.io/en/latest/reference/core.html) · [Identity](https://lessonkit.readthedocs.io/en/latest/reference/identity.html) · [Telemetry](https://lessonkit.readthedocs.io/en/latest/reference/telemetry.html) · [Plugins](https://lessonkit.readthedocs.io/en/latest/reference/plugins.html)
|
|
19
41
|
|
|
20
|
-
|
|
21
|
-
- Typed telemetry events (`TelemetryEvent`) and `telemetry-catalog.v1.json`
|
|
22
|
-
- Tracking client (`createTrackingClient`) with optional batching
|
|
23
|
-
- Session id helper (`createSessionId`)
|
|
42
|
+
## License
|
|
24
43
|
|
|
25
|
-
|
|
44
|
+
Apache-2.0
|