remote-calibrator 0.3.0 → 0.5.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remote-calibrator",
-  "version": "0.3.0",
+  "version": "0.5.0-beta.3",
   "description": "Useful calibration tools for remote psychophysics experiments.",
   "main": "lib/RemoteCalibrator.min.js",
   "directories": {
@@ -31,28 +31,28 @@
   "devDependencies": {
     "@babel/core": "^7.15.8",
     "autoprefixer": "^10.3.7",
-    "babel-loader": "^8.2.2",
+    "babel-loader": "^8.2.3",
     "clean-webpack-plugin": "^4.0.0",
-    "css-loader": "^6.4.0",
+    "css-loader": "^6.5.0",
     "css-minimizer-webpack-plugin": "^3.1.1",
     "cssnano": "^5.0.8",
-    "eslint": "^7.32.0",
-    "eslint-webpack-plugin": "^3.0.1",
+    "eslint": "^8.1.0",
+    "eslint-webpack-plugin": "^3.1.0",
     "express": "^4.17.1",
-    "googleapis": "^88.2.0",
-    "husky": "^7.0.2",
-    "lint-staged": "^11.2.3",
-    "nodemon": "^2.0.13",
+    "googleapis": "^89.0.0",
+    "husky": "^7.0.4",
+    "lint-staged": "^11.2.6",
+    "nodemon": "^2.0.14",
     "postcss-loader": "^6.2.0",
     "prettier": "^2.4.1",
-    "sass": "^1.43.2",
+    "sass": "^1.43.4",
     "sass-loader": "^12.2.0",
-    "style-loader": "^3.3.0",
+    "style-loader": "^3.3.1",
     "svg-inline-loader": "^0.8.2",
     "terser-webpack-plugin": "^5.2.4",
     "url-loader": "^4.1.1",
-    "webpack": "^5.58.2",
-    "webpack-cli": "^4.9.0",
+    "webpack": "^5.60.0",
+    "webpack-cli": "^4.9.1",
     "webpack-modules": "^1.0.0",
     "xlsx": "^0.17.3"
   },
@@ -62,10 +62,10 @@
   },
   "dependencies": {
     "animate.css": "^4.1.1",
-    "device-detector-js": "^2.2.10",
+    "device-detector-js": "^3.0.0",
     "platform": "^1.3.6",
     "react-fast-compare": "^3.2.0",
-    "sweetalert2": "^11.1.8",
+    "sweetalert2": "^11.1.9",
     "tinycolor2": "^1.4.2",
     "tone": "^14.7.77"
   }

package/src/WebGazer4RC/.gitattributes

@@ -0,0 +1,10 @@
+# Handle line endings automatically for files detected as text
+# and leave all files detected as binary untouched.
+* text=auto
+
+# Force the following filetypes to have unix eols, so Windows does not break them
+*.* text eol=lf
+*.png binary
+*.jpg binary
+*.eot binary
+*.ttf binary

package/src/WebGazer4RC/LICENSE.md

@@ -0,0 +1,15 @@
+WebGazer.js - Scalable browser-based webcam eye tracking
+
+Copyright (C) 2021 Brown HCI Group
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU 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, 
+but WITHOUT ANY WARRANTY; without even the implied warranty of 
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

package/src/WebGazer4RC/README.md

@@ -0,0 +1,142 @@
+# [WebGazer.js](https://webgazer.cs.brown.edu)
+
+WebGazer.js is an eye tracking library that uses common webcams to infer the eye-gaze locations of web visitors on a page in real time. The eye tracking model it contains self-calibrates by watching web visitors interact with the web page and trains a mapping between the features of the eye and positions on the screen. WebGazer.js is written entirely in JavaScript and with only a few lines of code can be integrated in any website that wishes to better understand their visitors and transform their user experience. WebGazer.js runs entirely in the client browser, so no video data needs to be sent to a server. WebGazer.js can run only if the user consents in giving access to their webcam.
+
+* [Official website](https://webgazer.cs.brown.edu)
+* [API Docs](https://github.com/brownhci/WebGazer/wiki/Top-Level-API)
+
+## Features
+
+* Real time gaze prediction on most major browsers
+* No special hardware; WebGazer.js uses your webcam
+* Self-calibration from clicks and cursor movements
+* Easy to integrate with a few lines of JavaScript
+* Swappable components for eye detection
+* Multiple gaze prediction models
+* Useful video feedback to user
+
+## Build the repository
+
+If you want to build the repository from source follow these instructions:
+
+    # Ensure NodeJS is downloaded: https://nodejs.org/en/download/
+    git clone https://github.com/brownhci/WebGazer.git
+    cd WebGazer
+    #install the dependencies
+    npm install
+    #build the project
+    npm run build
+
+<!-- To use the webgazer script in the head of an HTML file add the `async` tag to ensure the clmtrackr does not collapse to a slower version -->
+
+## Examples
+
+Examples of how WebGazer.js works can be found [here](https://webgazer.cs.brown.edu/#examples).
+
+### to use on any website
+
+```
+<script src="webgazer.js" type="text/javascript" >
+```
+
+### to use in any modern framework
+
+````  
+const webgazer = require('webgazer'); // npm package 'webgazer' is sync with this repository
+```` 
+
+or you can you do
+
+```` 
+import webgazer from 'webgazer'
+````
+
+### How to run the Example HTML files
+
+Within the /www directory there are two example HTML files:
+
+  * `calibration.html`: This example includes additional user feedback, such as a 9-point calibration sequence, accuracy measurements and an informative help module.
+  * `collision.html`: This example contains a game where the user can move an orange ball with their eyes, which in turn collides with blue balls.
+
+To run the example files as a server:
+
+	# Clone the repository and download NodeJS using the steps listed above
+	# Move into the www directory and download the additional dependencies
+	cd www
+	npm install
+	# Run the webpage index.html as a server
+	npm run serve
+
+## Browser Support
+
+The following browsers support WebGazer.js:
+
+  * Google Chrome
+  * Microsoft Edge
+  * Mozilla Firefox
+  * Opera
+  * Safari
+
+## Publications
+
+  _**Note:** The current iteration of WebGazer no longer corresponds with the WebGazer described in the following publications and which can be found [here](https://github.com/brownhci/WebGazer/tree/2a4a70cb49b2d568a09362e1b52fd3bd025cd38d)._
+
+	@inproceedings{papoutsaki2016webgazer,
+	author     = {Alexandra Papoutsaki and Patsorn Sangkloy and James Laskey and Nediyana Daskalova and Jeff Huang and James Hays},
+	title      = {{WebGazer}: Scalable Webcam Eye Tracking Using User Interactions},
+    booktitle  = {Proceedings of the 25th International Joint Conference on Artificial Intelligence (IJCAI-16)},
+    pages      = {3839--3845},
+	year       = {2016},
+	organization={AAAI}
+	}
+
+	@inproceedings{papoutsaki2017searchgazer,
+	author     = {Alexandra Papoutsaki and James Laskey and Jeff Huang},
+    title      = {SearchGazer: Webcam Eye Tracking for Remote Studies of Web Search},
+    booktitle  = {Proceedings of the ACM SIGIR Conference on Human Information Interaction \& Retrieval (CHIIR)},
+    year       = {2017},
+    organization={ACM}
+    }
+
+    @inproceedings{papoutsaki2018eye,
+    author={Papoutsaki, Alexandra and Gokaslan, Aaron and Tompkin, James and He, Yuze and Huang, Jeff},
+    title={The eye of the typer: a benchmark and analysis of gaze behavior during typing.},
+    booktitle={Proceedings of the 2018 ACM Symposium on Eye Tracking Research \& Applications (ETRA)},
+    pages={16--1},
+    year={2018},
+    organization={ACM}
+    }
+
+
+
+## Who We Are
+
+  * Alexandra Papoutsaki
+  * Aaron Gokaslan
+  * Ida De Smet
+  * Xander Koo
+  * James Tompkin
+  * Jeff Huang
+
+## Other Collaborators
+
+  * Nediyana Daskalova
+  * James Hays
+  * Yuze He
+  * James Laskey
+  * Patsorn Sangkloy
+  * Elizabeth Stevenson
+  * Preston Tunnell Wilson
+  * Jack Wong
+
+### Acknowledgements
+
+Webgazer is developed based on the research that is done by Brown University, with recent work at Pomona College. The work of the calibration example file was developed in the context of a course project with the aim to improve the feedback of WebGazer. It was proposed by Dr. Gerald Weber and his team Dr. Clemens Zeidler and Kai-Cheung Leung.
+
+This research is supported by NSF grants IIS-1464061, IIS-1552663, and the Brown University Salomon Award.
+
+## License
+
+Copyright (C) 2021 [Brown HCI Group](http://hci.cs.brown.edu)
+
+Licensed under GPLv3. Companies have the option to license WebGazer.js under LGPLv3 while their valuation is under $1,000,000.

package/src/WebGazer4RC/gnu-lgpl-v3.0.md

@@ -0,0 +1,163 @@
+GNU Lesser General Public License
+=================================
+
+_Version 3, 29 June 2007_  
+_Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+### 0. Additional Definitions
+
+As used herein, “this License” refers to version 3 of the GNU Lesser
+General Public License, and the “GNU GPL” refers to version 3 of the GNU
+General Public License.
+
+“The Library” refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the “Linked
+Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+### 1. Exception to Section 3 of the GNU GPL
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+### 2. Conveying Modified Versions
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+* **a)** under this License, provided that you make a good faith effort to
+ensure that, in the event an Application does not supply the
+function or data, the facility still operates, and performs
+whatever part of its purpose remains meaningful, or
+
+* **b)** under the GNU GPL, with none of the additional permissions of
+this License applicable to that copy.
+
+### 3. Object Code Incorporating Material from Library Header Files
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+* **a)** Give prominent notice with each copy of the object code that the
+Library is used in it and that the Library and its use are
+covered by this License.
+* **b)** Accompany the object code with a copy of the GNU GPL and this license
+document.
+
+### 4. Combined Works
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+* **a)** Give prominent notice with each copy of the Combined Work that
+the Library is used in it and that the Library and its use are
+covered by this License.
+
+* **b)** Accompany the Combined Work with a copy of the GNU GPL and this license
+document.
+
+* **c)** For a Combined Work that displays copyright notices during
+execution, include the copyright notice for the Library among
+these notices, as well as a reference directing the user to the
+copies of the GNU GPL and this license document.
+
+* **d)** Do one of the following:
+    - **0)** Convey the Minimal Corresponding Source under the terms of this
+License, and the Corresponding Application Code in a form
+suitable for, and under terms that permit, the user to
+recombine or relink the Application with a modified version of
+the Linked Version to produce a modified Combined Work, in the
+manner specified by section 6 of the GNU GPL for conveying
+Corresponding Source.
+    - **1)** Use a suitable shared library mechanism for linking with the
+Library.  A suitable mechanism is one that **(a)** uses at run time
+a copy of the Library already present on the user's computer
+system, and **(b)** will operate properly with a modified version
+of the Library that is interface-compatible with the Linked
+Version.
+
+* **e)** Provide Installation Information, but only if you would otherwise
+be required to provide such information under section 6 of the
+GNU GPL, and only to the extent that such information is
+necessary to install and execute a modified version of the
+Combined Work produced by recombining or relinking the
+Application with a modified version of the Linked Version. (If
+you use option **4d0**, the Installation Information must accompany
+the Minimal Corresponding Source and Corresponding Application
+Code. If you use option **4d1**, you must provide the Installation
+Information in the manner specified by section 6 of the GNU GPL
+for conveying Corresponding Source.)
+
+### 5. Combined Libraries
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+* **a)** Accompany the combined library with a copy of the same work based
+on the Library, uncombined with any other library facilities,
+conveyed under the terms of this License.
+* **b)** Give prominent notice with the combined library that part of it
+is a work based on the Library, and explaining where to find the
+accompanying uncombined form of the same work.
+
+### 6. Revised Versions of the GNU Lesser General Public License
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License “or any later version”
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.