@playkit-js/transcript 3.1.0 → 3.2.0-canary.2-0254f9e

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 CHANGED
@@ -2,6 +2,18 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ## [3.2.0-canary.2-0254f9e](https://github.com/kaltura/playkit-js-transcript/compare/v3.1.0...v3.2.0-canary.2-0254f9e) (2023-01-10)
6
+
7
+
8
+ ### Features
9
+
10
+ * **FEV-1640:** add cypress tests ([#123](https://github.com/kaltura/playkit-js-transcript/issues/123)) ([0254f9e](https://github.com/kaltura/playkit-js-transcript/commit/0254f9e3878dd5bdbe31cb84063488381c138f54))
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **FEV-1534:** init transcript plugin only if captions exist ([#121](https://github.com/kaltura/playkit-js-transcript/issues/121)) ([015410f](https://github.com/kaltura/playkit-js-transcript/commit/015410f85e340b39b2166a4d6424c2de365cbe19))
16
+
5
17
  ## [3.1.0](https://github.com/kaltura/playkit-js-transcript/compare/v3.0.1...v3.1.0) (2022-12-12)
6
18
 
7
19
 
package/README.md CHANGED
@@ -28,12 +28,23 @@ yarn install
28
28
 
29
29
  ### Building
30
30
 
31
- Then, build the player
31
+ Then, build the plugin
32
32
 
33
33
  ```javascript
34
34
  yarn run build
35
35
  ```
36
36
 
37
+ ### Testing
38
+
39
+ The plugin uses `cypress` tool for e2e tests
40
+
41
+ ```javascript
42
+ yarn run test
43
+ ```
44
+
45
+ UI conf file (`cypress/public/ui-conf.js`) contains Kaltura player and plugin dependencies.
46
+ Keep Kaltura player and dependency versinos aligned to currently released versions.
47
+
37
48
  ### Embed the library in your test page
38
49
 
39
50
  Finally, add the bundle as a script tag in your page, and initialize the player
@@ -54,7 +65,7 @@ Finally, add the bundle as a script tag in your page, and initialize the player
54
65
  ...
55
66
  targetId: 'player-placeholder',
56
67
  plugins: {
57
- transcript: { ... },
68
+ 'playkit-js-transcript': { ... },
58
69
  uiManagers: { ... },
59
70
  kalturaCuepoints: { ... },
60
71
  }
@@ -76,14 +87,6 @@ Transcript plugin dependencies can been found here:
76
87
 
77
88
  - **[Dependencies](#dependencies)**
78
89
 
79
- ### And coding style tests
80
-
81
- We use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.
82
-
83
- See [ESLint config](.eslintrc.json) for full configuration.
84
-
85
- We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
86
-
87
90
  ## Contributing
88
91
 
89
92
  Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.