@launchdarkly/session-replay 0.0.1 → 0.1.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/CHANGELOG.md +7 -0
- package/README.md +33 -16
- package/package.json +14 -13
package/CHANGELOG.md
ADDED
package/README.md
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
# LaunchDarkly JavaScript Session Replay SDK for Browsers
|
|
2
2
|
|
|
3
|
-
[![NPM][
|
|
4
|
-
[![Actions Status][
|
|
5
|
-
[![
|
|
6
|
-
[![NPM][
|
|
7
|
-
[![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link]
|
|
3
|
+
[![NPM][o11y-sdk-npm-badge]][o11y-sdk-npm-link]
|
|
4
|
+
[![Actions Status][o11y-sdk-ci-badge]][o11y-sdk-ci]
|
|
5
|
+
[![NPM][o11y-sdk-dm-badge]][o11y-sdk-npm-link]
|
|
6
|
+
[![NPM][o11y-sdk-dt-badge]][o11y-sdk-npm-link]
|
|
8
7
|
|
|
9
8
|
# ⛔️⛔️⛔️⛔️
|
|
10
9
|
|
|
@@ -13,17 +12,36 @@
|
|
|
13
12
|
|
|
14
13
|
# ☝️☝️☝️☝️☝️☝️
|
|
15
14
|
|
|
16
|
-
<!--
|
|
17
15
|
## Install
|
|
18
16
|
|
|
17
|
+
Install the package
|
|
19
18
|
```shell
|
|
20
19
|
# npm
|
|
21
20
|
npm i @launchdarkly/session-replay
|
|
22
21
|
|
|
23
22
|
# yarn
|
|
24
|
-
yarn add
|
|
23
|
+
yarn add @launchdarkly/session-replay
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Update your web app entrypoint.
|
|
27
|
+
```tsx
|
|
28
|
+
import { initialize } from 'launchdarkly-js-client-sdk'
|
|
29
|
+
import SessionReplay, { LDRecord } from '@launchdarkly/session-replay'
|
|
30
|
+
|
|
31
|
+
const client = init3(
|
|
32
|
+
'<CLIENT_SIDE_ID>',
|
|
33
|
+
{ key: 'authenticated-user@example.com' },
|
|
34
|
+
{
|
|
35
|
+
// Not including plugins at all would be equivalent to the current LaunchDarkly SDK.
|
|
36
|
+
plugins: [
|
|
37
|
+
new SessionReplay('<OBSERVABILITY_PROJECT_ID>', {
|
|
38
|
+
serviceName: 'example-svc',
|
|
39
|
+
}), // Could be omitted for customers who cannot use session replay.
|
|
40
|
+
],
|
|
41
|
+
},
|
|
42
|
+
)
|
|
43
|
+
|
|
25
44
|
```
|
|
26
|
-
-->
|
|
27
45
|
|
|
28
46
|
## Getting started
|
|
29
47
|
|
|
@@ -35,6 +53,7 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply
|
|
|
35
53
|
|
|
36
54
|
## About LaunchDarkly
|
|
37
55
|
|
|
56
|
+
- LaunchDarkly Session Replay provies a way to capture user sessions on your application to replay them in LaunchDarkly. Understand how users are interacting with your site and with new features you ship.
|
|
38
57
|
- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
|
|
39
58
|
- Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
|
|
40
59
|
- Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
|
|
@@ -48,11 +67,9 @@ LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply
|
|
|
48
67
|
- [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
|
|
49
68
|
- [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
|
|
50
69
|
|
|
51
|
-
[
|
|
52
|
-
[
|
|
53
|
-
[
|
|
54
|
-
[
|
|
55
|
-
[
|
|
56
|
-
[
|
|
57
|
-
[browser-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/js-client-sdk.svg?style=flat-square
|
|
58
|
-
[browser-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/js-client-sdk.svg?style=flat-square
|
|
70
|
+
[o11y-sdk-ci-badge]: https://github.com/launchdarkly/observability-sdk/actions/workflows/turbo.yml/badge.svg
|
|
71
|
+
[o11y-sdk-ci]: https://github.com/launchdarkly/observability-sdk/actions/workflows/turbo.yml
|
|
72
|
+
[o11y-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/session-replay.svg?style=flat-square
|
|
73
|
+
[o11y-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/session-replay
|
|
74
|
+
[o11y-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/session-replay.svg?style=flat-square
|
|
75
|
+
[o11y-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/session-replay.svg?style=flat-square
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@launchdarkly/session-replay",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Browser observability for your web app. Record session replays to visualize usage patterns.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"launchdarkly",
|
|
@@ -22,20 +22,21 @@
|
|
|
22
22
|
"url": "https://github.com/launchdarkly/observability-sdk.git"
|
|
23
23
|
}
|
|
24
24
|
},
|
|
25
|
+
"scripts": {
|
|
26
|
+
"typegen": "tsc",
|
|
27
|
+
"build": "vite build"
|
|
28
|
+
},
|
|
29
|
+
"devDependencies": {
|
|
30
|
+
"highlight.run": "9.18.0",
|
|
31
|
+
"rollup-plugin-visualizer": "^5.14.0",
|
|
32
|
+
"typescript": "^5.8.3",
|
|
33
|
+
"vite": "^6.3.4",
|
|
34
|
+
"vitest": "^3.1.2"
|
|
35
|
+
},
|
|
25
36
|
"type": "module",
|
|
26
|
-
"main": "./dist/
|
|
27
|
-
"module": "./dist/
|
|
28
|
-
"unpkg": "./dist/index.umd.js",
|
|
29
|
-
"jsdelivr": "./dist/index.umd.js",
|
|
37
|
+
"main": "./dist/session-replay.js",
|
|
38
|
+
"module": "./dist/session-replay.js",
|
|
30
39
|
"types": "./dist/index.d.ts",
|
|
31
|
-
"exports": {
|
|
32
|
-
"types": "./dist/index.d.ts",
|
|
33
|
-
"unpkg": "./dist/index.umd.js",
|
|
34
|
-
"jsdelivr": "./dist/index.umd.js",
|
|
35
|
-
"import": "./dist/index.js",
|
|
36
|
-
"require": "./dist/index.js",
|
|
37
|
-
"default": "./dist/index.js"
|
|
38
|
-
},
|
|
39
40
|
"files": [
|
|
40
41
|
"dist"
|
|
41
42
|
],
|