diff --git a/.gitignore b/.gitignore index 1db9a782..8aaf98db 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ node_modules coverage browser +.vscode diff --git a/package-lock.json b/package-lock.json index 64e91150..b332cccf 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4037,28 +4037,28 @@ "dependencies": { "abbrev": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", + "resolved": false, "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", "dev": true, "optional": true }, "ansi-regex": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "resolved": false, "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", "dev": true, "optional": true }, "aproba": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/aproba/-/aproba-1.2.0.tgz", + "resolved": false, "integrity": "sha512-Y9J6ZjXtoYh8RnXVCMOU/ttDmk1aBjunq9vO0ta5x85WDQiQfUF9sIPBITdbiiIVcBo03Hi3jMxigBtsddlXRw==", "dev": true, "optional": true }, "are-we-there-yet": { "version": "1.1.5", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-1.1.5.tgz", + "resolved": false, "integrity": "sha512-5hYdAkZlcG8tOLujVDTgCT+uPX0VnpAH28gWsLfzpXYm7wP6mp5Q/gYyR7YQ0cKVJcXJnl3j2kpBan13PtQf6w==", "dev": true, "optional": true, @@ -4069,14 +4069,14 @@ }, "balanced-match": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "resolved": false, "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", "dev": true, "optional": true }, "brace-expansion": { "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "resolved": false, "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", "dev": true, "optional": true, @@ -4087,42 +4087,42 @@ }, "chownr": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.1.tgz", + "resolved": false, "integrity": "sha512-j38EvO5+LHX84jlo6h4UzmOwi0UgW61WRyPtJz4qaadK5eY3BTS5TY/S1Stc3Uk2lIM6TPevAlULiEJwie860g==", "dev": true, "optional": true }, "code-point-at": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", + "resolved": false, "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", "dev": true, "optional": true }, "concat-map": { "version": "0.0.1", - "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "resolved": false, "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", "dev": true, "optional": true }, "console-control-strings": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", + "resolved": false, "integrity": "sha1-PXz0Rk22RG6mRL9LOVB/mFEAjo4=", "dev": true, "optional": true }, "core-util-is": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "resolved": false, "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", "dev": true, "optional": true }, "debug": { "version": "4.1.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz", + "resolved": false, "integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==", "dev": true, "optional": true, @@ -4132,28 +4132,28 @@ }, "deep-extend": { "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "resolved": false, "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", "dev": true, "optional": true }, "delegates": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delegates/-/delegates-1.0.0.tgz", + "resolved": false, "integrity": "sha1-hMbhWbgZBP3KWaDvRM2HDTElD5o=", "dev": true, "optional": true }, "detect-libc": { "version": "1.0.3", - "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-1.0.3.tgz", + "resolved": false, "integrity": "sha1-+hN8S9aY7fVc1c0CrFWfkaTEups=", "dev": true, "optional": true }, "fs-minipass": { "version": "1.2.5", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-1.2.5.tgz", + "resolved": false, "integrity": "sha512-JhBl0skXjUPCFH7x6x61gQxrKyXsxB5gcgePLZCwfyCGGsTISMoIeObbrvVeP6Xmyaudw4TT43qV2Gz+iyd2oQ==", "dev": true, "optional": true, @@ -4163,14 +4163,14 @@ }, "fs.realpath": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "resolved": false, "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", "dev": true, "optional": true }, "gauge": { "version": "2.7.4", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-2.7.4.tgz", + "resolved": false, "integrity": "sha1-LANAXHU4w51+s3sxcCLjJfsBi/c=", "dev": true, "optional": true, @@ -4187,7 +4187,7 @@ }, "glob": { "version": "7.1.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "resolved": false, "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", "dev": true, "optional": true, @@ -4202,14 +4202,14 @@ }, "has-unicode": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz", + "resolved": false, "integrity": "sha1-4Ob+aijPUROIVeCG0Wkedx3iqLk=", "dev": true, "optional": true }, "iconv-lite": { "version": "0.4.24", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "resolved": false, "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", "dev": true, "optional": true, @@ -4219,7 +4219,7 @@ }, "ignore-walk": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-3.0.1.tgz", + "resolved": false, "integrity": "sha512-DTVlMx3IYPe0/JJcYP7Gxg7ttZZu3IInhuEhbchuqneY9wWe5Ojy2mXLBaQFUQmo0AW2r3qG7m1mg86js+gnlQ==", "dev": true, "optional": true, @@ -4229,7 +4229,7 @@ }, "inflight": { "version": "1.0.6", - "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "resolved": false, "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", "dev": true, "optional": true, @@ -4240,21 +4240,21 @@ }, "inherits": { "version": "2.0.3", - "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "resolved": false, "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", "dev": true, "optional": true }, "ini": { "version": "1.3.5", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.5.tgz", + "resolved": false, "integrity": "sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==", "dev": true, "optional": true }, "is-fullwidth-code-point": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", + "resolved": false, "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", "dev": true, "optional": true, @@ -4264,14 +4264,14 @@ }, "isarray": { "version": "1.0.0", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "resolved": false, "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", "dev": true, "optional": true }, "minimatch": { "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "resolved": false, "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", "dev": true, "optional": true, @@ -4281,14 +4281,14 @@ }, "minimist": { "version": "0.0.8", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", + "resolved": false, "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", "dev": true, "optional": true }, "minipass": { "version": "2.3.5", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-2.3.5.tgz", + "resolved": false, "integrity": "sha512-Gi1W4k059gyRbyVUZQ4mEqLm0YIUiGYfvxhF6SIlk3ui1WVxMTGfGdQ2SInh3PDrRTVvPKgULkpJtT4RH10+VA==", "dev": true, "optional": true, @@ -4299,7 +4299,7 @@ }, "minizlib": { "version": "1.2.1", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-1.2.1.tgz", + "resolved": false, "integrity": "sha512-7+4oTUOWKg7AuL3vloEWekXY2/D20cevzsrNT2kGWm+39J9hGTCBv8VI5Pm5lXZ/o3/mdR4f8rflAPhnQb8mPA==", "dev": true, "optional": true, @@ -4309,7 +4309,7 @@ }, "mkdirp": { "version": "0.5.1", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", + "resolved": false, "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", "dev": true, "optional": true, @@ -4319,14 +4319,14 @@ }, "ms": { "version": "2.1.1", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.1.tgz", + "resolved": false, "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg==", "dev": true, "optional": true }, "needle": { "version": "2.3.0", - "resolved": "https://registry.npmjs.org/needle/-/needle-2.3.0.tgz", + "resolved": false, "integrity": "sha512-QBZu7aAFR0522EyaXZM0FZ9GLpq6lvQ3uq8gteiDUp7wKdy0lSd2hPlgFwVuW1CBkfEs9PfDQsQzZghLs/psdg==", "dev": true, "optional": true, @@ -4338,7 +4338,7 @@ }, "node-pre-gyp": { "version": "0.12.0", - "resolved": "https://registry.npmjs.org/node-pre-gyp/-/node-pre-gyp-0.12.0.tgz", + "resolved": false, "integrity": "sha512-4KghwV8vH5k+g2ylT+sLTjy5wmUOb9vPhnM8NHvRf9dHmnW/CndrFXy2aRPaPST6dugXSdHXfeaHQm77PIz/1A==", "dev": true, "optional": true, @@ -4357,7 +4357,7 @@ }, "nopt": { "version": "4.0.1", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-4.0.1.tgz", + "resolved": false, "integrity": "sha1-0NRoWv1UFRk8jHUFYC0NF81kR00=", "dev": true, "optional": true, @@ -4368,14 +4368,14 @@ }, "npm-bundled": { "version": "1.0.6", - "resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-1.0.6.tgz", + "resolved": false, "integrity": "sha512-8/JCaftHwbd//k6y2rEWp6k1wxVfpFzB6t1p825+cUb7Ym2XQfhwIC5KwhrvzZRJu+LtDE585zVaS32+CGtf0g==", "dev": true, "optional": true }, "npm-packlist": { "version": "1.4.1", - "resolved": "https://registry.npmjs.org/npm-packlist/-/npm-packlist-1.4.1.tgz", + "resolved": false, "integrity": "sha512-+TcdO7HJJ8peiiYhvPxsEDhF3PJFGUGRcFsGve3vxvxdcpO2Z4Z7rkosRM0kWj6LfbK/P0gu3dzk5RU1ffvFcw==", "dev": true, "optional": true, @@ -4386,7 +4386,7 @@ }, "npmlog": { "version": "4.1.2", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-4.1.2.tgz", + "resolved": false, "integrity": "sha512-2uUqazuKlTaSI/dC8AzicUck7+IrEaOnN/e0jd3Xtt1KcGpwx30v50mL7oPyr/h9bL3E4aZccVwpwP+5W9Vjkg==", "dev": true, "optional": true, @@ -4399,21 +4399,21 @@ }, "number-is-nan": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", + "resolved": false, "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=", "dev": true, "optional": true }, "object-assign": { "version": "4.1.1", - "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "resolved": false, "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", "dev": true, "optional": true }, "once": { "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "resolved": false, "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", "dev": true, "optional": true, @@ -4423,21 +4423,21 @@ }, "os-homedir": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz", + "resolved": false, "integrity": "sha1-/7xJiDNuDoM94MFox+8VISGqf7M=", "dev": true, "optional": true }, "os-tmpdir": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", + "resolved": false, "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=", "dev": true, "optional": true }, "osenv": { "version": "0.1.5", - "resolved": "https://registry.npmjs.org/osenv/-/osenv-0.1.5.tgz", + "resolved": false, "integrity": "sha512-0CWcCECdMVc2Rw3U5w9ZjqX6ga6ubk1xDVKxtBQPK7wis/0F2r9T6k4ydGYhecl7YUBxBVxhL5oisPsNxAPe2g==", "dev": true, "optional": true, @@ -4448,21 +4448,21 @@ }, "path-is-absolute": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "resolved": false, "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", "dev": true, "optional": true }, "process-nextick-args": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", + "resolved": false, "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==", "dev": true, "optional": true }, "rc": { "version": "1.2.8", - "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "resolved": false, "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", "dev": true, "optional": true, @@ -4475,7 +4475,7 @@ "dependencies": { "minimist": { "version": "1.2.0", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", + "resolved": false, "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", "dev": true, "optional": true @@ -4484,7 +4484,7 @@ }, "readable-stream": { "version": "2.3.6", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", + "resolved": false, "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", "dev": true, "optional": true, @@ -4500,7 +4500,7 @@ }, "rimraf": { "version": "2.6.3", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz", + "resolved": false, "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==", "dev": true, "optional": true, @@ -4510,49 +4510,49 @@ }, "safe-buffer": { "version": "5.1.2", - "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "resolved": false, "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", "dev": true, "optional": true }, "safer-buffer": { "version": "2.1.2", - "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "resolved": false, "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "dev": true, "optional": true }, "sax": { "version": "1.2.4", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", + "resolved": false, "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", "dev": true, "optional": true }, "semver": { "version": "5.7.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.0.tgz", + "resolved": false, "integrity": "sha512-Ya52jSX2u7QKghxeoFGpLwCtGlt7j0oY9DYb5apt9nPlJ42ID+ulTXESnt/qAQcoSERyZ5sl3LDIOw0nAn/5DA==", "dev": true, "optional": true }, "set-blocking": { "version": "2.0.0", - "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "resolved": false, "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", "dev": true, "optional": true }, "signal-exit": { "version": "3.0.2", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", + "resolved": false, "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", "dev": true, "optional": true }, "string-width": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", + "resolved": false, "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", "dev": true, "optional": true, @@ -4564,7 +4564,7 @@ }, "string_decoder": { "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "resolved": false, "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", "dev": true, "optional": true, @@ -4574,7 +4574,7 @@ }, "strip-ansi": { "version": "3.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "resolved": false, "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", "dev": true, "optional": true, @@ -4584,14 +4584,14 @@ }, "strip-json-comments": { "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "resolved": false, "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", "dev": true, "optional": true }, "tar": { "version": "4.4.8", - "resolved": "https://registry.npmjs.org/tar/-/tar-4.4.8.tgz", + "resolved": false, "integrity": "sha512-LzHF64s5chPQQS0IYBn9IN5h3i98c12bo4NCO7e0sGM2llXQ3p2FGC5sdENN4cTW48O915Sh+x+EXx7XW96xYQ==", "dev": true, "optional": true, @@ -4607,14 +4607,14 @@ }, "util-deprecate": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "resolved": false, "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", "dev": true, "optional": true }, "wide-align": { "version": "1.1.3", - "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.3.tgz", + "resolved": false, "integrity": "sha512-QGkOQc8XL6Bt5PwnsExKBPuMKBxnGxWWW3fU55Xt4feHozMUhdUMaBCk290qpm/wG5u/RSKzwdAC4i51YigihA==", "dev": true, "optional": true, @@ -4624,14 +4624,14 @@ }, "wrappy": { "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "resolved": false, "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", "dev": true, "optional": true }, "yallist": { "version": "3.0.3", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.0.3.tgz", + "resolved": false, "integrity": "sha512-S+Zk8DEWE6oKpV+vI3qWkaK+jSbIK86pCwe2IF/xwIpQ8jEuxpw9NyaGjmp9+BoJv5FV2piqCDcoCtStppiq2A==", "dev": true, "optional": true diff --git a/src/firestore-document-snapshot.js b/src/firestore-document-snapshot.js index 6afce33f..3cd90606 100644 --- a/src/firestore-document-snapshot.js +++ b/src/firestore-document-snapshot.js @@ -2,7 +2,7 @@ var _ = require('./lodash'); -function MockFirestoreDocumentSnapshot (id, ref, data) { +function MockFirestoreDocumentSnapshot(id, ref, data) { this.id = id; this.ref = ref; this._snapshotdata = _.cloneDeep(data) || null; @@ -10,9 +10,13 @@ function MockFirestoreDocumentSnapshot (id, ref, data) { return _.cloneDeep(this._snapshotdata); }; this.exists = this._snapshotdata !== null; + this.metadata = { + fromCache: true, + hasPendingWrites: false + }; } -MockFirestoreDocumentSnapshot.prototype.get = function (path) { +MockFirestoreDocumentSnapshot.prototype.get = function(path) { if (!path || !this.exists) return undefined; var parts = path.split('.'); diff --git a/src/firestore-document.js b/src/firestore-document.js index ce31c285..e7400471 100644 --- a/src/firestore-document.js +++ b/src/firestore-document.js @@ -200,6 +200,45 @@ MockFirestoreDocument.prototype.delete = function (callback) { }); }; +MockFirestoreDocument.prototype.onSnapshot = function (optionsOrObserverOrOnNext, observerOrOnNextOrOnError, onErrorArg) { + var err = this._nextErr('onSnapshot'); + var self = this; + var onNext = optionsOrObserverOrOnNext; + var onError = observerOrOnNextOrOnError; + var includeMetadataChanges = optionsOrObserverOrOnNext.includeMetadataChanges; + + if (includeMetadataChanges) { + // Note this doesn't truly mimic the firestore metadata changes behavior, however + // since everything is syncronous, there isn't any difference in behavior. + onNext = observerOrOnNextOrOnError; + onError = onErrorArg; + } + var context = { + data: self._getData(), + }; + var onSnapshot = function (forceTrigger) { + // compare the current state to the one from when this function was created + // and send the data to the callback if different. + if (err === null) { + if (!_.isEqual(self.data, context.data) || includeMetadataChanges || forceTrigger) { + onNext(new DocumentSnapshot(self.id, self.ref, self._getData())); + context.data = self._getData(); + } + } else { + onError(err); + } + }; + + // onSnapshot should always return when initially called, then + // every time data changes. + onSnapshot(true); + var unsubscribe = this.queue.onPostFlush(onSnapshot); + + // return the unsubscribe function + return unsubscribe; +}; + + /** * Fetches the subcollections that are direct children of the document. * @see https://cloud.google.com/nodejs/docs/reference/firestore/0.15.x/DocumentReference#getCollections diff --git a/src/firestore-query.js b/src/firestore-query.js index 270cd5b0..6be6e282 100644 --- a/src/firestore-query.js +++ b/src/firestore-query.js @@ -1,15 +1,12 @@ 'use strict'; var _ = require('./lodash'); -var assert = require('assert'); var Stream = require('stream'); var Promise = require('rsvp').Promise; -var autoId = require('firebase-auto-ids'); -var DocumentSnapshot = require('./firestore-document-snapshot'); var QuerySnapshot = require('./firestore-query-snapshot'); +var DocumentSnapshot = require('./firestore-document-snapshot'); var Queue = require('./queue').Queue; var utils = require('./utils'); -var validate = require('./validators'); function MockFirestoreQuery(path, data, parent, name) { this.errs = {}; @@ -69,51 +66,9 @@ MockFirestoreQuery.prototype.get = function () { var self = this; return new Promise(function (resolve, reject) { self._defer('get', _.toArray(arguments), function () { - var results = {}; - var limit = 0; - var atStart = false; - var atEnd = false; - var startFinder = this.buildStartFinder(); - - var inRange = function(data, key) { - if (atEnd) { - return false; - } else if (atStart) { - return true; - } else { - atStart = startFinder(data, key); - return atStart; - } - }; - + var results = self._results(); if (err === null) { if (_.size(self.data) !== 0) { - if (self.orderedProperties.length === 0) { - _.forEach(self.data, function(data, key) { - if (inRange(data, key) && (self.limited <= 0 || limit < self.limited)) { - results[key] = _.cloneDeep(data); - limit++; - } - }); - } else { - var queryable = []; - _.forEach(self.data, function(data, key) { - queryable.push({ - data: data, - key: key - }); - }); - - queryable = _.orderBy(queryable, _.map(self.orderedProperties, function(p) { return 'data.' + p; }), self.orderedDirections); - - queryable.forEach(function(q) { - if (inRange(q.data, q.key) && (self.limited <= 0 || limit < self.limited)) { - results[q.key] = _.cloneDeep(q.data); - limit++; - } - }); - } - resolve(new QuerySnapshot(self.parent === null ? self : self.parent.collection(self.id), results)); } else { resolve(new QuerySnapshot(self.parent === null ? self : self.parent.collection(self.id))); @@ -233,6 +188,107 @@ MockFirestoreQuery.prototype.clone = function () { return query; }; +MockFirestoreQuery.prototype.onSnapshot = function (optionsOrObserverOrOnNext, observerOrOnNextOrOnError, onErrorArg) { + var err = this._nextErr('onSnapshot'); + var self = this; + var onNext = optionsOrObserverOrOnNext; + var onError = observerOrOnNextOrOnError; + var includeMetadataChanges = optionsOrObserverOrOnNext.includeMetadataChanges; + + if (includeMetadataChanges) { + // Note this doesn't truly mimic the firestore metadata changes behavior, however + // since everything is syncronous, there isn't any difference in behavior. + onNext = observerOrOnNextOrOnError; + onError = onErrorArg; + } + var context = { + data: self._results(), + }; + var onSnapshot = function (forceTrigger) { + // compare the current state to the one from when this function was created + // and send the data to the callback if different. + if (err === null) { + if (forceTrigger) { + const results = self._results(); + if (_.size(self.data) !== 0) { + onNext(new QuerySnapshot(self.parent === null ? self : self.parent.collection(self.id), results)); + } else { + onNext(new QuerySnapshot(self.parent === null ? self : self.parent.collection(self.id))); + } + } else { + self.get().then(function (querySnapshot) { + var results = self._results(); + if (!_.isEqual(results, context.data) || includeMetadataChanges) { + onNext(new QuerySnapshot(self.parent === null ? self : self.parent.collection(self.id), results)); + context.data = results; + } + }); + } + } else { + onError(err); + } + }; + + // onSnapshot should always return when initially called, then + // every time data changes. + onSnapshot(true); + var unsubscribe = this.queue.onPostFlush(onSnapshot); + + // return the unsubscribe function + return unsubscribe; +}; + +MockFirestoreQuery.prototype._results = function () { + var results = {}; + var limit = 0; + var atStart = false; + var atEnd = false; + var startFinder = this.buildStartFinder(); + + var inRange = function(data, key) { + if (atEnd) { + return false; + } else if (atStart) { + return true; + } else { + atStart = startFinder(data, key); + return atStart; + } + }; + if (_.size(this.data) === 0) { + return results; + } + + var self = this; + if (this.orderedProperties.length === 0) { + _.forEach(this.data, function(data, key) { + if (inRange(data, key) && (self.limited <= 0 || limit < self.limited)) { + results[key] = _.cloneDeep(data); + limit++; + } + }); + } else { + var queryable = []; + _.forEach(self.data, function(data, key) { + queryable.push({ + data: data, + key: key + }); + }); + + queryable = _.orderBy(queryable, _.map(self.orderedProperties, function(p) { return 'data.' + p; }), self.orderedDirections); + + queryable.forEach(function(q) { + if (inRange(q.data, q.key) && (self.limited <= 0 || limit < self.limited)) { + results[q.key] = _.cloneDeep(q.data); + limit++; + } + }); + } + + return results; +}; + MockFirestoreQuery.prototype._defer = function (sourceMethod, sourceArgs, callback) { this.queue.push({ fn: callback, diff --git a/src/queue.js b/src/queue.js index bbe12433..78177dfc 100644 --- a/src/queue.js +++ b/src/queue.js @@ -6,6 +6,7 @@ var EventEmitter = require('events').EventEmitter; function FlushQueue () { this.events = []; + this.postFlushListeners = []; } FlushQueue.prototype.push = function () { @@ -23,6 +24,14 @@ FlushQueue.prototype.push = function () { })); }; +FlushQueue.prototype.onPostFlush = function(subscriber) { + this.postFlushListeners.push(subscriber); + var self = this; + return function() { + self.postFlushListeners.pop(subscriber); + }; +}; + FlushQueue.prototype.flushing = false; FlushQueue.prototype.flush = function (delay) { @@ -33,6 +42,9 @@ FlushQueue.prototype.flush = function (delay) { } function process () { self.flushing = true; + _.forEach(self.postFlushListeners, function (subscriber) { + self.push(subscriber); + }); while (self.events.length) { self.events[0].run(); } diff --git a/test/unit/firestore-collection.js b/test/unit/firestore-collection.js index 20884cdf..679994dc 100644 --- a/test/unit/firestore-collection.js +++ b/test/unit/firestore-collection.js @@ -419,4 +419,99 @@ describe('MockFirestoreCollection', function () { ]); }); }); + + describe('#onSnapshot', function () { + it('returns value after collection is updated', function (done) { + var callCount = 0; + collection.onSnapshot(function(snap) { + callCount += 1; + var names = []; + snap.docs.forEach(function(doc) { + names.push(doc.data().name); + }); + + if (callCount === 2) { + expect(names).to.contain('A'); + expect(names).not.to.contain('a'); + done(); + } + }); + collection.doc('a').update({name: 'A'}, {setMerge: true}); + collection.flush(); + }); + + it('calls callback after multiple updates', function (done) { + var callCount = 0; + collection.onSnapshot(function(snap) { + callCount += 1; + var names = []; + snap.docs.forEach(function(doc) { + names.push(doc.data().name); + }); + + if (callCount === 2) { + expect(names).to.contain('A'); + expect(names).not.to.contain('a'); + } + + if (callCount === 3) { + expect(names).to.contain('AA'); + expect(names).not.to.contain('A'); + done(); + } + }); + + collection.doc('a').update({name: 'A'}, {setMerge: true}); + collection.flush(); + collection.doc('a').update({name: 'AA'}, {setMerge: true}); + collection.flush(); + }); + + it('should unsubscribe', function (done) { + var callCount = 0; + var unsubscribe = collection.onSnapshot(function(snap) { + callCount += 1; + }); + + collection.doc('a').update({name: 'A'}, {setMerge: true}); + collection.flush(); + + process.nextTick(function() { + expect(callCount).to.equal(2); + + collection.doc('a').update({name: 'AA'}, {setMerge: true}); + unsubscribe(); + + collection.flush(); + + process.nextTick(function() { + expect(callCount).to.equal(2); + done(); + }); + }); + + + }); + + it('Calls onError if error', function (done) { + var error = new Error("An error occured."); + collection.errs.onSnapshot = error; + var callCount = 0; + collection.onSnapshot(function(snap) { + throw new Error("This should not be called."); + }, function(err) { + // onSnapshot always returns when first called and then + // after data changes so we get 2 calls here. + if (callCount == 0) { + callCount++; + return; + } + expect(err).to.equal(error); + done(); + }); + collection.doc('a').update({name: 'A'}, {setMerge: true}); + collection.flush(); + }); + + }); }); diff --git a/test/unit/firestore-document.js b/test/unit/firestore-document.js index 83f19346..f3d30b26 100644 --- a/test/unit/firestore-document.js +++ b/test/unit/firestore-document.js @@ -497,4 +497,89 @@ describe('MockFirestoreDocument', function () { }); }); }); + + describe('#onSnapshot', function () { + it('calls observer with initial state', function (done) { + doc.onSnapshot(function(snap) { + expect(snap.get('title')).to.equal('title'); + done(); + }); + }); + + it('calls observer when document is updated', function (done) { + // onSnapshot calls immediately with the current state; + // we only care about the updated.. + var first = true; + doc.onSnapshot(function(snap) { + if (!first) { + expect(snap.get('newTitle')).to.equal('A new title'); + done(); + } + + first = false; + }); + doc.update({newTitle: 'A new title'}, {setMerge: true}); + db.flush(); + }); + + it('does not call observer when no changes occur', function (done) { + var first = true; + + doc.onSnapshot(function(snap) { + if (!first) throw new Error('Observer called unexpectedly!'); + first = false; + }); + + doc.update({title: 'title'}, {setMerge: true}); + db.flush(); + done(); + }); + + it('returns error if error occured', function (done) { + var error = new Error("An error occured."); + doc.errs.onSnapshot = error; + doc.onSnapshot(function(snap) { + throw new Error("This should not be called."); + }, function(err) { + expect(err).to.equal(error); + done(); + }); + }); + + it('does not returns value when not updated', function (done) { + var callCount = 0; + doc.onSnapshot(function(snap) { + callCount += 1; + }); + doc.update({newTitle: 'A new title'}, {setMerge: true}); + doc.flush(); + expect(callCount).to.equal(2); + doc.get(); + doc.flush(); + expect(callCount).to.equal(2); + done(); + }); + + it('unsubscribes', function (done) { + var callCount = 0; + var unsubscribe = doc.onSnapshot(function(snap) { + callCount += 1; + }); + doc.update({newTitle: 'A new title'}, {setMerge: true}); + doc.flush(); + expect(callCount).to.equal(2); + doc.update({newTitle: 'A newer title'}, {setMerge: true}); + unsubscribe(); + doc.flush(); + expect(callCount).to.equal(2); + done(); + }); + + it('accepts option includeMetadataChanges', function (done) { + doc.onSnapshot({includeMetadataChanges: true}, function(snap) { + expect(snap.get('title')).to.equal('title'); + done(); + }); + }); + }); });