reabsed with master

Author: Pietro Passarelli - News Labs

.babelrc

@@ -1,6 +1,12 @@
 {
 	"presets": [
-		"@babel/preset-react"
+		"@babel/preset-react",
+		"@babel/preset-env",
+		["minify", {
+			"builtIns": false,
+			"evaluate": false,
+			"mangle": false,
+		  }]
 	],
 	"plugins": [
 		"@babel/plugin-proposal-object-rest-spread", 

.eslintrc

@@ -43,6 +43,7 @@
     "newline-before-return": "error",
     "space-before-blocks": "error",
     "no-unused-vars": "error",
+    "no-multi-spaces": "warn",
     "comma-spacing": ["error", { "before": false, "after": true }],
     "prefer-destructuring": ["error", {
       "VariableDeclarator": {

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: pietrop
 
 ---
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
+title: ''
+labels: Enhancement
+assignees: pietrop
 
 ---
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,6 +1,9 @@
 ---
 name: Question
 about: Ask a question about this project
+title: ''
+labels: bug
+assignees: pietrop
 
 ---
 

.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
- - "node"
  - "10"
 
 install:

CONTRIBUTING.md

@@ -18,7 +18,7 @@ By submitting code as an individual or as an entity you agree that your code is
 5. If you've added code that should be tested, add tests, if you need help with automated testing, feel free to raise an [issue](https://github.com/bbc/react-transcript-editor/issues/new?template=feature_request.md).
 6. Ensure the test suite passes.
 7. Make sure your code lints.
-8. If you've changed APIs, consider [updating the documentation](https://github.com/bbc/react-transcript-editor#documentation).
+8. If you've changed APIs, consider [updating the documentation](https://github.com/bbc/react-transcript-editor#documentation) and QA Testing docs.
 9. Once the work is complete push the branch up on to GitHub for review. Make sure your branch is up to date with `master` before making a pull request. eg use [`git merge origin/master`](https://git-scm.com/docs/git-merge) or [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
 10. Once a branch has been merged into `master`, delete it.
 
@@ -41,7 +41,7 @@ See [this blog post for more on this](https://medium.com/mindorks/how-to-write-c
 - [ ] Ensure test suite passes (`npm run test`)
 - [ ] Make sure your code lints. (`npm run lint`)
 - [ ] consider re-factoring for code quality and readability
-- [ ] Update documentation where appropriate [updating the documentation](https://github.com/bbc/react-transcript-editor#documentation)
+- [ ] Update documentation and QA docs where appropriate - [see updating the documentation](https://github.com/bbc/react-transcript-editor#documentation)
 - [ ] Setup your PR for review 
 
 <!-- 

README.md

@@ -65,10 +65,14 @@ import { TranscriptEditor } from '@bbc/react-transcript-editor';
     transcriptData=// Transcript json
     mediaUrl=// string url to media file - audio or video 
     isEditable={true}// se to true if you want to be able to edit the text
-    sttJsonType={ 'bbcKaldi' }// the type of STT Json transcript supported.
+    sttJsonType={ 'bbckaldi' }// the type of STT Json transcript supported.
+    fileName={ this.state.fileName }// optional*
 />
 ```
 
+_Note: `fileName` it is optional but it's needed if working with user uploaded local media in the browser, to be able to save and retrieve from local storage. For instance if you are passing a blob url to `mediaUrl` using `createObjectURL` this url is randomly re-generated on every page refresh so you wouldn't be able to restore a session, as `mediaUrl` is used as the local storage key. See demo app for more detail example of this[`./src/index.js`](./src/index.js)_
+
+
 ## System Architecture
 
 <!-- _High level overview of system architecture_ -->
@@ -93,6 +97,7 @@ There's a [docs](./docs) folder in this repository.
 
 We are using [this template for ADR](https://gist.github.com/iaincollins/92923cc2c309c2751aea6f1b34b31d95)
 
+[There also QA testing docs](./docs/qa/README.md) to manual test the component before a major release, (QA testing does not require any technical knowledge).
 
 ## Build
 

dist/index.js

@@ -0,0 +1,112 @@
+# Frequency of local storage save
+
+* Status: **accepted** <!-- optional -->
+* Deciders: Pietro <!-- optional -->
+* Date: 2019-01-24 <!-- optional -->
+
+<!-- Technical Story: [description | ticket/issue URL]  -->
+
+## Context and Problem Statement
+
+<!-- [Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.] -->
+
+The issue is how often to save to local storage when a user types, previous implementation saved every 5 characters. But that caused issues [#86](https://github.com/bbc/react-transcript-editor/issues/86)
+
+
+
+## Decision Drivers <!-- optional -->
+
+<!-- * [driver 1, e.g., a force, facing concern, …] -->
+* A simple and straight forward way to save to local storage
+* saving on a good frequency 
+* without introducing performance issues especially on less performant devices
+* if possible without introducing third party dependencies 
+
+## Considered Options
+
+* [loadash debounce](https://lodash.com/docs/4.17.11#debounce)
+* using a js timer 
+
+## Notes on debounce option 
+
+What is a debounce function?
+
+> debounce function does, it limits the rate at which a function can fire.
+> [...] You'll pass the debounce function the function to execute and the fire rate limit in milliseconds
+
+from https://john-dugan.com/javascript-debounce/ 
+
+In more detail
+
+https://davidwalsh.name/javascript-debounce-function
+
+with examples
+
+https://css-tricks.com/debouncing-throttling-explained-examples/ 
+
+
+https://lodash.com/docs/4.17.11#debounce
+
+## Decision Outcome
+
+Chosen option: **using a js timer**. 
+
+It uses a timer that can be consolidated into one final one rather then having a lot of saves being delayed, we just have one final save once after user has stopped typing for more then 5 seconds.
+
+The timer is cleared before being called so that there is only the final one left. Leaving only one final save at the end. As a performance optimization.
+
+```js
+if (this.saveTimer!== undefined) {
+    clearTimeout(this.saveTimer);
+}
+this.saveTimer = setTimeout(() => {
+    this.localSave(this.props.mediaUrl);
+}, 5000);
+```
+
+
+ <!-- because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)]. -->
+
+
+<!-- 
+### Positive Consequences
+
+* [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
+* …
+
+### Negative consequences 
+
+* [e.g., compromising quality attribute, follow-up decisions required, …]
+* …
+
+## Pros and Cons of the Options 
+
+### [option 1]
+
+[example | description | pointer to more information | …] 
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
+
+### [option 2]
+
+[example | description | pointer to more information | …]
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
+
+
+### [option 3]
+
+[example | description | pointer to more information | …] 
+
+* Good, because [argument a]
+* Good, because [argument b]
+* Bad, because [argument c]
+
+
+## Links 
+
+* [Link type] [Link to ADR]  -->