@playkit-js/moderation 2.1.1 → 2.2.0-canary.10-af41e17

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.2.0-canary.10-af41e17](https://github.com/kaltura/playkit-js-moderation/compare/v2.1.1...v2.2.0-canary.10-af41e17) (2022-09-13)
+
+
+### Features
+
+* **FEV-1274:** moderation plugin move contrib kitchen sink to core side panels ([#24](https://github.com/kaltura/playkit-js-moderation/issues/24)) ([4290705](https://github.com/kaltura/playkit-js-moderation/commit/42907058f9449d0f6c35f4e8320e1595460cfc82))
+* **FEV-1274:** use ui managers from @playkit-js/common repo ([#26](https://github.com/kaltura/playkit-js-moderation/issues/26)) ([71fcdc0](https://github.com/kaltura/playkit-js-moderation/commit/71fcdc049dc8f294fa9dd0bef1f1bb428de3b098))
+
+
+### Bug Fixes
+
+* **FEV-1398:** moderation style fixes ([#29](https://github.com/kaltura/playkit-js-moderation/issues/29)) ([f255db1](https://github.com/kaltura/playkit-js-moderation/commit/f255db10115e2d003cd7328e8b8a255680d80f41))
+* revert plugin name to playkit-js-moderation ([#30](https://github.com/kaltura/playkit-js-moderation/issues/30)) ([af41e17](https://github.com/kaltura/playkit-js-moderation/commit/af41e1791669802d780fe8a034855484d6c85253))
+
 ### [2.1.1](https://github.com/kaltura/playkit-js-moderation/compare/v2.0.11...v2.1.1) (2022-01-19)
 
 ### [2.0.11](https://github.com/kaltura/playkit-js-moderation/compare/v2.0.10...v2.0.11) (2021-12-06)

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,12 +1,178 @@
-# Kaltura Player V7 - Moderation plugin
+# PlayKit JS Moderation - 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 Moderation 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
 
-## Commands
-> this section will be added soon
+### Prerequisites
+
+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-moderation.git
+cd playkit-js-moderation
+yarn install
+```
+
+### Building
+
+Then, build the player
+
+```javascript
+yarn run build
+```
+
+### 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-moderation.js"></script>
+<!--PlayKit moderation 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: {
+       moderation: { ... }
+     }
+     ...
+    };
+    var player = KalturaPlayer.setup(config);
+    player.loadMedia(...);
+  </script>
+</div>
+```
+
+## Documentation
+
+Moderation plugin configuration can been found here:
+
+- **[Configuration](#configuration)**
+
+### 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.
+
+## 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-moderation/tags).
+
+## License
+
+This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details
+
+<a name="configuration"></a>
+## Configuration
+
+#### Configuration Structure
+
+```js
+//Default configuration
+"moderation" = {};
+//Plugin params
+"moderation" = {
+  reportLength?: number, // optional
+  onReportSentMessage?: string, // optional
+  onReportErrorMessage?: string, // optional
+  subtitle?: string, // optional
+  tooltipMessage?: string, // optional
+  notificatonDuration?: number, // optional
+  moderateOptions?: Array< {id: number, label: string} > // optional
+}
+```
+
+##
+
+> ### config.reportLength
+>
+> ##### Type: `number`
+>
+> ##### Default: `500`
+>
+
+##
+
+> ### config.onReportSentMessage
+>
+> ##### Type: `string`
+>
+> ##### Default: `The report sent`
+>
+
+##
+
+> ### config.onReportErrorMessage
+>
+> ##### Type: `string`
+>
+> ##### Default: `The report failed to send`
+>
+
+##
+
+> ### config.subtitle
+>
+> ##### Type: `string`
+>
+> ##### Default: `-`
+>
+
+##
+
+> ### config.tooltipMessage
+>
+> ##### Type: `string`
+>
+> ##### Default: `Send report`
+>
+
+##
+
+> ### config.notificatonDuration
+>
+> ##### Type: `number`
+>
+> ##### Default: `5000`
+>
+
+##
+
+> ### config.moderateOptions
+>
+> ##### Type: `Array< {id: number, label: string} >`
+>
+> ##### Default: 
+```js
+moderateOptions = [
+  {id: 1, label: 'Sexual Content'},      
+  {id: 2, label: 'Violent Or Repulsive'},      
+  {id: 3, label: 'Harmful Or Dangerous Act'},      
+  {id: 4, label: 'Spam / Commercials'}
+]
+```
+>