@playkit-js/transcript 2.1.5-canary.0-d147d48 → 2.1.5-canary.17-c901bf0

package/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 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.
 
-### [2.1.5-canary.0-d147d48](https://github.com/kaltura/playkit-js-transcript/compare/v2.1.4...v2.1.5-canary.0-d147d48) (2022-01-19)
+### [2.1.5-canary.17-c901bf0](https://github.com/kaltura/playkit-js-transcript/compare/v2.1.4...v2.1.5-canary.17-c901bf0) (2022-08-10)
+
+
+### Bug Fixes
+
+* **FEV-1173:** remove contrib kitchen sink ([fb40b3e](https://github.com/kaltura/playkit-js-transcript/commit/fb40b3e10a99cd2cf7ffb41ac5721ab6b3210501))
+* **FEV-1273:** handle timed metadata, remove kaltura-client ([357f8b5](https://github.com/kaltura/playkit-js-transcript/commit/357f8b53cffe64b0da1152f96c6c54f677142bfb))
+* **FEV-1273:** tiny style changes ([4967668](https://github.com/kaltura/playkit-js-transcript/commit/49676686b24cd36a0881e2f5897c472a7e555b94))
+* **FEV-1346:** style-loader fix ([#99](https://github.com/kaltura/playkit-js-transcript/issues/99)) ([c901bf0](https://github.com/kaltura/playkit-js-transcript/commit/c901bf08054df133274bf2e5fcf8568009a936c6))
 
 ### [2.1.4](https://github.com/kaltura/playkit-js-transcript/compare/v2.1.3...v2.1.4) (2022-01-19)
 

package/LICENSE

@@ -1,7 +1,7 @@
                     GNU AFFERO GENERAL PUBLIC LICENSE
                        Version 3, 19 November 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -633,8 +633,8 @@ the "copyright" line and a pointer to where the full notice is found.
     Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
+    it under the terms of the GNU Affero General Public License as published
+    by the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
@@ -643,7 +643,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -658,4 +658,4 @@ specific requirements.
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU AGPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.

package/README.md

@@ -1,32 +1,130 @@
-# Kaltura Player V7 - Transcript plugin
+# PlayKit JS Transcript - plugin for the [PlayKit JS Player]
 
-[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+PlayKit JS Transcript is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].
 
-## Overview
-> this section will be added soon
+[typescript]: https://www.typescriptlang.org/
+[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
+[babel]: https://babeljs.io
 
-## Project structure
-> this section will be added soon
+## Getting Started
 
-## Plugin configuration
+### Prerequisites
 
-### Plugin configuration can be defined as object of properties, ex: 
+The plugin requires [Kaltura Player] to be loaded first.
+
+[kaltura player]: https://github.com/kaltura/kaltura-player-js
+
+### Installing
+
+First, clone and run [yarn] to install dependencies:
+
+[yarn]: https://yarnpkg.com/lang/en/
+
+```
+git clone https://github.com/kaltura/playkit-js-transcript.git
+cd playkit-js-transcript
+yarn install
 ```
-            'playkit-js-transcript': {
-                position: 'right',
-                printDisabled : true,
-                expandMode:'over'
-            }
+
+### Building
+
+Then, build the player
+
+```javascript
+yarn run build
 ```
 
-### List of available configuration properties:
-Parameter | Description | Type | Default 
---- | --- | :-----: | :-----:
-expandMode | Set player area for TW | `"alongside" | "over"` | `"alongside"`
-expandOnFirstPlay | Opens plugin on automatically | `boolean` | `true`
-showTime | Show or hide caption time | `boolean` | `true`
-position | Position of TW plugin | `"right" | "bottom"` | `"bottom"`
-searchDebounceTimeout | Debounce on caption search | `number` | `250`
-searchNextPrevDebounceTimeout | Debounce on jump to prev\next search result | `number` | `100`
-downloadDisabled | Disable download of transcript | `boolean` | `false`
-printDisabled | Disable print of transcript | `boolean` | `false`
+### Embed the library in your test page
+
+Finally, add the bundle as a script tag in your page, and initialize the player
+
+```html
+<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
+<!--Kaltura player-->
+<script type="text/javascript" src="/PATH/TO/FILE/playkit-transcript.js"></script>
+<!--PlayKit transcript plugin-->
+<div id="player-placeholder" style="height:360px; width:640px">
+  <script type="text/javascript">
+    var playerContainer = document.querySelector("#player-placeholder");
+    var config = {
+     ...
+     targetId: 'player-placeholder',
+     plugins: {
+       transcript: { ... },
+       kalturaCuepoints: {}
+     }
+     ...
+    };
+    var player = KalturaPlayer.setup(config);
+    player.loadMedia(...);
+  </script>
+</div>
+```
+
+## Documentation
+
+TBD
+
+## Running the tests
+
+Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari
+
+[karma]: https://karma-runner.github.io/1.0/index.html
+
+```
+yarn run test
+```
+
+You can test individual browsers:
+
+```
+yarn run test:chrome
+yarn run test:firefox
+yarn run test:safari
+```
+
+### And coding style tests
+
+We use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.
+
+See [ESLint config](.eslintrc.json) for full configuration.
+
+We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
+
+## Compatibility
+
+TBD
+
+## Contributing
+
+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.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-transcript/tags).
+
+## License
+
+This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Commands
+
+Run dev server: `npm run serve`;<br/>
+Update contrib: `npm run infra:latest`;<br/>
+Bump version: `npm run deploy:prepare`;<br/>
+
+## Configuration
+
+Plugin configuration:<br/> > `expandOnFirstPlay`: boolean - if plugin should automatically opens on first play (default true);<br/> > `forceChaptersThumb`: boolean - force to use chapters thumbnails (default false);<br/> > `expandMode`: string - expand mode of kitchensink (AlongSideTheVideo|OverTheVideo, default "AlongSideTheVideo");<br/> > `userRole`: string - use session userId as identificator of user (anonymousRole|unmoderatedAdminRole, default "anonymousRole");<br/> > `itemsOrder`: object< string, number > - define order of Tabs (min value at the left) and Items inside group (min value at the top).<br/> itemsOrder also uses as tabs filter (all items that not included in "itemsOrder" object will be filtered out) (default:
+` { "All": 0, "Chapter": 1, "Slide": 2, "Hotspot": 3, "AnswerOnAir": 4, } ); `
+
+## Troubleshooting
+
+### Dev env
+
+Node version: up to 14.18.1<br/>
+If nvm installed: `nvm use` change version of current terminal to required.<br/>
+
+### ARM Architecture support
+
+Install dependencies with `npm install --target_arch=x64` set target arch for running it through Rosetta (requires Rosetta installation).<br/>