.eslintrc

@@ -0,0 +1,26 @@
+{
+  "extends": "airbnb",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+  "rules": {
+    "semi": 2,
+    "no-unused-vars" : "off",
+    "comma-dangle" : "off",
+    "no-plusplus" : "off",
+    "no-restricted-properties" : "off",
+    "prefer-template" : "off",
+    "import/no-extraneous-dependencies" : "off",
+    "import/prefer-default-export" : "off",
+    "max-len": ["off", 100, 2, {
+      "ignoreUrls": true,
+      "ignoreComments": false,
+      "ignoreStrings": true,
+      "ignoreTemplateLiterals": true
+    }]
+  }
+}

.gitignore

@@ -1,7 +1,8 @@
 bower_components
+node_modules
+!build/docs/node_modules
 *~
 *#
 *.idea
 /escrow/
 /.bowerrc
-/docs

CHANGELOG.md

@@ -1,14 +1,105 @@
-# Change Log
+# [v5.1.0](https://github.com/MyScript/myscript-text-web/tree/v5.1.0)
 
-## [v1.2.1](https://github.com/MyScript/myscript-text-web/tree/v1.2.1)
+## Features
 
-### Bugs
+- Addition of a new Recognition Assets Builder API to dynamically build text lexicons and math grammars
+- Style and decoration support in the JIIX exports
+- New configuration options for a finer tuning of JIIX exports
+- Always connected is now the default mode for better end user experience
+
+# [v5.0.0](https://github.com/MyScript/myscript-text-web/tree/v5.0.0)
+
+## Features
+
+`myscript-text-web` now supports all the features introduced by the version [4.2.0 of MyScriptJS](https://github.com/MyScript/myscriptjs/tree/v4.2.0).
+
+## Breaking changes
+
+- We are now using Polymer 3. For more details, please refer to the [Polymer documentation](https://www.polymer-project.org/3.0/docs/about_30).
+
+# [v4.1.1](https://github.com/MyScript/myscript-text-web/tree/v4.1.1)
+
+## Bugs fixed
+- Documentation and paper buttons colors were not taken into account in Edge.
+
+## Breaking changes
+
+In order to be consistent with the native API :
+- `disableguidelines` renamed to `disableguides` in the configuration.
+
+# [v4.1.0](https://github.com/MyScript/myscript-text-web/tree/v4.1.0)
+
+## Features
+- Modifications to include smart guide from MyScriptJS
+    - New `disablesmartguide` property to disable smart guide.
+    - New `disablesmartguidefadeout` and  `smartguidefadeoutduration` to disable smart guide fadeout or modify the duration.
+- New `usepointerlisteners` property used to force the pointer events use.
+- New guides for text using a svg DOM element behind the model layer and `disableguidelines` to disable the guides.
+- No more css background if api is set to `V4`.
+- Google fonts supports (see the [example](./examples/v4/change_fonts.html)).
+- Custom resources support, upload your custom resources to modify the recognition behaviour (see the [example](./examples/v4/custom_resources.html)).
+- New `penStyleClasses` property. Used to change the theme using classes passed using the `theme` property (see the [example](./examples/non-version-specific/customize_style.html)).
+
+## Breaking changes
+- `importContent()` and `exportContent()` respectively renamed to `import_()` and `export_()`.
+- `importInk(strokes)` changed to `pointerEvents(events)`.
+
+# [v4.0.1](https://github.com/MyScript/myscript-text-web/tree/v4.0.1)
+
+## Bug fixed
+- Editor on iOS wasn't working properly due to touch-action: none in CSS not supported in Safari.
+
+# [v4.0.0](https://github.com/MyScript/myscript-text-web/tree/v4.0.0)
+
+## Features
+- New events to be notified of editor changes. 
+- New `unloaded` flag to control component state. `load` event will be trigger once the editor will be fully loaded.
+- New **not mutable** `configuration` attribute. Changing the configuration will clear the underlying editor, all currents strokes and results will be lost. To do it, set `unloaded=true` after changing configuration, and wait for a `load` event.
+- New **read-only** `editor` property that allow you to access to the underlying editor object (see [MyScriptJS documentation]() for more details).
+- New CSS variables to customize the web-component. See [examples/styling.html](examples/styling.html) as an example.
+
+## Breaking changes
+- Complete rewrite of the underlying javascript library with ES6 syntax
+- Internal design improved to allow extensibility and support of upcoming recognition types. Documentation and illustrating samples to come in next release. 
+- Removal of all deprecated attributes and methods
+- All events has been renamed. See the [documentation](docs/index.html) to discover new behavior.
+- `resulttypes`, `language`, `typeset`, `textparameters`, `mathparameters`, `shapeparameters`, `musicparameters`, `analyzerparameters` are replaced by the unique `configuration` attribute (see [MyScriptJS documentation]() for a complete spec).
+- Renamed `timeout` attribute to `recognitiontriggerdelay`
+- Renamed `delete()` property to `clear()`
+- Changed `ssl` attribute to a `scheme` attribute (i.e. `ssl=true` will be replaced by `scheme=https`)
+- `getAvailableLanguages()` have been replaced by a new web-component. You can use it to retrieve the list of available languages for your configuration.
+
+## Bugs
+- User can no longer write when an unrecoverable error is detected forcing him to reload the page. See [examples/handle_error.html](examples/handle_error.html) to see how it works.
+
+For more details about attributes, look at the [documentation](docs/index.html).
+
+## Limits
+- `myscript-text-web` does not support pure shadow DOM. Still some issues to use underlying css.
+
+# [v1.2.3](https://github.com/MyScript/myscript-text-web/tree/v1.2.3)
+
+## Features
+- Change colors to fit the new MyScript Developer theme
+
+# [v1.2.2](https://github.com/MyScript/myscript-text-web/tree/v1.2.2)
+
+## Features
+- New `strokecolor` attribute to setup/change stroke color settings
+- New `strokewidth` attribute to setup/change stroke width settings
+
+## Bugs
+- See [MyScriptJS v1.2.2](https://github.com/MyScript/MyScriptJS/tree/v1.2.2) for fixes
+
+# [v1.2.1](https://github.com/MyScript/myscript-text-web/tree/v1.2.1)
+
+## Bugs
 - Improve documentation of superimposed options
 - See [MyScriptJS v1.2.1](https://github.com/MyScript/MyScriptJS/tree/v1.2.1) for fixes
 
-## [v1.2.0](https://github.com/MyScript/myscript-text-web/tree/v1.2.0)
+# [v1.2.0](https://github.com/MyScript/myscript-text-web/tree/v1.2.0)
 
-### Features
+## Features
 - Mutable `host` attribute
 - Mutable `protocol` attribute
 - New `resultdetail` attribute 
@@ -26,7 +117,6 @@
 - Add docs/demo buttons on component page
 - Add getStats method to get various stats relative to ink in order to help evaluate the myscript cdk usage
 
-
-### Bugs
+## Bugs
 - Fixes issue on resize due to CSS
 - Explicit default values on documentation 

CONTRIBUTING.md

@@ -1,48 +1,9 @@
-# Contributing to MyScript Web
+# Contributing
 
-We gladly welcome pull requests to MyScript Web. If you would like to add or modify new or larger features, see the **Adding features** section below.
-If you have any questions, or need help solving a problem, feel free to stop by the [#MyScript forum](https://dev.myscript.com/support/forum/).
-
-## Code format
-
-* Filename in smallcaps,  
-* 4 spaces for indentation,  
-* 120 character-line length.
-
-In general, try to make your code blend in with the surrounding code.
-
-## Adding features
-
-Components are distributed as sets of HTML and CSS files. If the feature you want to add belongs to an existing component, add your contribution to the corresponding file.
-
-If you want to create a component, first create a new set of files (HTML and CSS) associated to this component. Filename should be the component name in smallcaps.
-
-## Testing
-
-Local testing can be done using the `web-component-tester` engine through a web server. First, install all dependencies `bower install` from the root folder of the project, then open the test page in a web browser.
-
-MyScript Web supports all major browsers. However, as it is hard to test all versions of all browsers, please test your changes in as many browsers as possible.
-
-Simply navigate to the `/test` directory of your element to run tests and launch your web server. If you are using [Polyserve](https://github.com/PolymerLabs/polyserve), open `http://localhost:8080/components/myscript-renderer/test/`.
-
-### web-component-tester
-
-Install [web-component-tester](https://github.com/Polymer/web-component-tester): `npm install -g web-component-tester`. You can then run your tests on all your local browsers: `wct`
-
-#### WCT Tips
-
-`wct -l chrome` will only run tests in Google Chrome.
-
-`wct -p` will keep the browsers alive after test runs (refresh to re-run).
-
-`wct test/some-file.html` will test only the files you specify.
+We gladly welcome pull requests to MyScript Web. If you have any questions, or need help to solve a problem, feel free to stop by the [#MyScript forum](https://dev.myscript.com/support/forum/).
 
 ## Contributor License Agreement
 
 In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG).
 
 Make sure you read the article **[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)** to understand the contributing process.
-
-## License
-
-This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).

LICENSE

@@ -1,176 +1,10 @@
-  Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
+Copyright MyScript.
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.