@loomhq/record-sdk 3.1.1 → 3.2.1-draft
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 +54 -0
- package/dist/cjs/index.js +11 -11
- package/dist/cjs/is-supported.js +1 -1
- package/dist/esm/index.js +11 -11
- package/dist/esm/is-supported.js +1 -1
- package/dist/record-sdk.d.ts +57 -33
- package/package.json +12 -13
package/README.md
CHANGED
|
@@ -1,3 +1,57 @@
|
|
|
1
1
|
# @loomhq/record-sdk
|
|
2
2
|
|
|
3
3
|
See our [docs site](https://dev.loom.com) for a detailed guide on how to use the sdk!
|
|
4
|
+
|
|
5
|
+
## 3.2.0
|
|
6
|
+
|
|
7
|
+
### Minor Changes
|
|
8
|
+
|
|
9
|
+
- bb42d5cf15: **Introducing:** `createInstance`, a new setup method for `@loomhq/record-sdk`
|
|
10
|
+
|
|
11
|
+
There are now three operating modes of the SDK:
|
|
12
|
+
|
|
13
|
+
- Standard
|
|
14
|
+
- Custom
|
|
15
|
+
- First Party (assumes customer is always authenticated)
|
|
16
|
+
|
|
17
|
+
For the sake of simplicity, the developer needs to explicitly say which mode they're using
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
// Example
|
|
21
|
+
const publicAppId: '<my public key>';
|
|
22
|
+
|
|
23
|
+
const instance = await createInstance({
|
|
24
|
+
mode: 'standard',
|
|
25
|
+
publicAppId,
|
|
26
|
+
});
|
|
27
|
+
```
|
|
28
|
+
### Patch Changes
|
|
29
|
+
|
|
30
|
+
- 142ef8c30e: Implement foundations for onboarding
|
|
31
|
+
- 6a7f688ad8: Navigate to share page edit tab when users are logged in
|
|
32
|
+
- 75c95a7853: Add in product name and entry point name into the recording start event
|
|
33
|
+
- cf9cde4bb3: Add types export to record-sdk package
|
|
34
|
+
- 7e223459ff: Add internal alpha banner for Hello domain
|
|
35
|
+
- cf01845b27: Bump Lens v11.9.0 to add small loader
|
|
36
|
+
- 3df205aeb9: Be explicit about the different modes the recorder can be in.
|
|
37
|
+
|
|
38
|
+
Changes:
|
|
39
|
+
|
|
40
|
+
- Deprecate `setApiKey` action
|
|
41
|
+
- Deprecate `setJws` action
|
|
42
|
+
- Introduce `setMode` action
|
|
43
|
+
|
|
44
|
+
The recorder can be in one of four modes:
|
|
45
|
+
|
|
46
|
+
- PendingSDK _(The recorder has been initialized)_
|
|
47
|
+
- CustomSDK
|
|
48
|
+
- StandardSDK
|
|
49
|
+
- First-Party
|
|
50
|
+
|
|
51
|
+
@loomhq/record-sdk@3.11 and below will continue to use setApiKey and setJws. When these actions are used, sdk-background will transform these actions to be as though setMode was used.
|
|
52
|
+
|
|
53
|
+
- 7e8de46708: add pre record menu analytics for the sdk
|
|
54
|
+
- 211ebf0d1d: Add in product identifier and entry point
|
|
55
|
+
- ef1c6c934a: Add changeset
|
|
56
|
+
- 6adf796331: Bump Lens to v11.11.0 to add custom height modals
|
|
57
|
+
- ad079d01c6: Fixes bug where SDK could not start recording when microphone is disabled
|