{"_id":"@sberdevices/assistant-client","_rev":"536-2c2ae8d5a22bf546ae2dddfdafbe21f5","name":"@sberdevices/assistant-client","dist-tags":{"latest":"5.0.2","canary":"5.1.0--canary.6.6cb0d2c05b1b21c8391789a76cd71dd9d69c44e3.0"},"versions":{"1.0.0-rc.1":{"name":"@sberdevices/assistant-client","version":"1.0.0-rc.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"UNLICENSED","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","react":"16.13.1","react-dom":"16.13.1","styled-components":"5.1.1","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","file-loader":"6.1.0","mock-socket":"9.0.3","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"gitHead":"77190c3dadadafa9f102eb877bcdc25033a78053","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.0-rc.1","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-H7pgQY6Xj67AQTEovH/v1ne0qtOKxeTwfrilAavFTw4gC94n/ei7Ec/mm1eGHZxVHwOGf7qoGRlHodDQQhbIFg==","shasum":"ec40bb82ecb7df4ca78d297d692c03a5fcd0d06f","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.0-rc.1.tgz","fileCount":54,"unpackedSize":560164,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJffwA9CRA9TVsSAnZWagAAdKEP+QBywBrWWbWHvlh0pzwq\n+JHeHSbmeHeVXAbhWLAhXwsj735cjukgNsRT9PbuIGSo9K6oAEho073Ey0ye\n3HTPYzdQmqev3Vg/zq+Xj2/zQre0Kh4ry200P5dumQWexJxGyszoAyyuPmYk\nM7eOUGQWBdkNEsPiDD4xbStbaw4vvmZzpVK4JHeerLndr63z41is+nL+0w7L\nVL8gNj9k6ETnQIwkWT76QtyAp2EVzfVL+iuWLuXLEIGwW3PNOR/XJnDMXFWI\nVQtqXnpnsEeeSu8eep8kGOqnq6Bge5lp+h0wURPWjS1xt2tTRPU+5CUrW7t1\nEzeE9XJZqhRg8mpWMpxbM2OGdlbSveFXGfNYKh4PO3DIWEIMvWUy+Rn/MYxt\nwUvJ+54LjemP3AG5GUpZJhPPwRGrQlB5vzE9rH9igEBaZpCU1Trsc3xr5xPO\nZTjETrTwimze6eUKgJAMY6I+VIyk8oSeMuVu0kEknaAhtvHFoVzDBR79FdpQ\nrxjUmELOMsNXgG3OLwqTVRbVOa3cAgUA/8o8lXWXcliv64gMG7S9bhxX+63A\nFjx9ITmQxn1O+57b5hal8Rau6MFbIEmd7qzcMQ9lOkZo0eCdxP5sr7UfFsNx\nN1F6qNFOsIkxZujk/7wFfdEFIO4JjzJpN1T2IYAVIp6NPsvcwvSbmuqvTpAr\ncR8n\r\n=qtBY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEPhgVIZyhjISYP+yf0ZXirTlURWD1X2Lf2a1h/2O/GlAiEA3DHliTrCggji3rNdubUrSJvJCSvNuzgpnbjcZ13itog="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.0-rc.1_1602158653354_0.5627825868684309"},"_hasShrinkwrap":false},"1.0.0-rc.2":{"name":"@sberdevices/assistant-client","version":"1.0.0-rc.2","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"UNLICENSED","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","react":"16.13.1","react-dom":"16.13.1","styled-components":"5.1.1","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","file-loader":"6.1.0","mock-socket":"9.0.3","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"gitHead":"9cbf47a74c98ddc53a8b7c566297860badf9ecf7","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.0-rc.2","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-JiOs1CJ4TsHvTTSyOmp13GgYsXYstmg5wBSDOOLqP60q20F0UZvOTI7F0U70SfxYjKR8dKGcebM+yQENKRKtBg==","shasum":"fb44cdd67659e55eb70cbfdc2c7057fb59e36ebd","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.0-rc.2.tgz","fileCount":54,"unpackedSize":560217,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfgD7vCRA9TVsSAnZWagAAnYoP/RkG4N9CKYALOZHlJHM3\nJH5ZXqlBHd95vK/XEDG/YjZDrwcAsDUhzfJnQeXMwZFQxR4oBqdthCse9Onv\n7SGGpJjjH4tdMjBsOD4qZTt5JhcbNI+80NikGHfqepGBBpZdsumHTcvS3Ev1\nmkCTHzRAEu9RAs/sPNBPY8VWtfju1Kq+BvsWqLaeUaWBVv/kMKLGtM9uJOEE\nM7JZ+keOSxuOJ/tz7kCySVwqJ3UYgd9Trnhlr7Mi/nMzsQPF3umaH8JwCi3B\na7WM09w/uRZDbpiogjnbyd1mQwpKK5jCAqh1/Ge3QMK0xQUfEV4MOQHbsxGD\nb6XaHrMfZYEUGPszMQJJ4H6esq1Rkx91iKZJboCc1A1BoKr5AQusHBNQZfYM\nGSahdtAZYL1/S1MVvLYYY6PIm3WT9A+2Os9ihElJzQcaJcMCdf4az5fyjAvu\nSDER18gMbY4zWDs0l4D1Ydq1we9nNpFEiiJmQc77jaZJHn7IbjpyJsKlgY1l\nBOs0T5tqB5L8nWyoybMptAery74pInAzgjWtjwq0cg6jVYisCxtI92SJfJt7\n9dEPzF3+SMEKhkYQzTDvhpIsFesPu0KgY4MKlboxOf/B2R7xFeXB3m2vGC/F\nXNO8ElowfoopggCqovjlkHf3EB8e1TnGmPKBF15OW2eJxrTiIzdm7PhED1nL\nAAW7\r\n=6x/j\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCqJRAUoa90XTMxH+a5+TNmTJ/iQL0ncNaJ+VzmSXZVVAIhAOruihD2n2rEHTtVcebUqi0ggeAZjrfr/XyP+6E6FjyG"}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.0-rc.2_1602240238744_0.0030399752105150224"},"_hasShrinkwrap":false},"1.0.0-rc.3":{"name":"@sberdevices/assistant-client","version":"1.0.0-rc.3","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"UNLICENSED","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","react":"16.13.1","react-dom":"16.13.1","styled-components":"5.1.1","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","file-loader":"6.1.0","mock-socket":"9.0.3","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"gitHead":"bca6d4018d9ee5b0e5eb6a84b2395f8b9e99c158","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.0-rc.3","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-4vhl3voRuRBCBFdgH3aj0EDYVfcdJjTSNWiU+SGv255pDYG3QVB6Nskh85aNb3mty8WrUJ82CepGEtR+H+kO7Q==","shasum":"23de3c094680abce067aebe4b1170de408436dcc","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.0-rc.3.tgz","fileCount":54,"unpackedSize":559281,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfhYs3CRA9TVsSAnZWagAAmBcP/0CZDr/gcxuB0A5jOs6x\nLSOpDO1dWnrS46mw36yUhGRHKNW/qC5dbYLsRlIHu8cVdP4RQi/QSmrEFBvI\nKxbSxl6hOcyXyFjLulKSZLNZCLPj7+fhBZb6b5emSpHJ0tvltTokPzqwvtqB\nt2l/dRhV7k9seBYXNJ7bmbcoK+spSdaa58iGnbOIGshv9s1sYsMrxFq5pCGz\n2pI+RGXkQTpyyzL6pTes+45BU5+hTDsTImZ7HrCDLN73RFOQXqEEka6PY1qd\n7YRI6BZKMNIePgakyvgqV46ZoaYPd/JMpnaKXd/i3WtkLIsS5DM8Nu/MvfVL\nOI6jNb5gbR5JO1755zZCSA6xMu/G9GPaLCUjTODk3HLBEM1QhATp6dSTMDQ0\na7Rkj/tpE2lY0vJ3cgMq0poo5NJyPK0IAt7jjE3gs/EHDeMNN7SGP4aypko4\nlsgtGqg6ypyhsvB+FjE30N9fJ8mfQpGfq+MrHmTtZqi6wHXeBp9PxeGSjgRg\nXaWi3fYiPMtdBj3qg5LAfWJP31x0xmjhwNk7k1YeW7DeS2VapfA62AwRAnZx\ng58gkK4G1WHar17AoAyzytQMU+SpPFKm2pPMmbz6QXhKpvygQ3DmD1pi1tYQ\nIuFIl3KjUF7pCjgDTfDUPSOYgHz553YK20s0WPyCzM2oWjOFjKbYMEYNRvIX\njoLj\r\n=xMOQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDz6zOzGjQ4UXLz3wTS7kaiTkbR599pqFuzz080p22b0gIgWpdvANlLTQ3APJ/c3Vc5xsXiPZGgXvov4NK24shOYR4="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.0-rc.3_1602587446993_0.3690955055915428"},"_hasShrinkwrap":false},"1.0.0-rc.4":{"name":"@sberdevices/assistant-client","version":"1.0.0-rc.4","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","react":"16.13.1","react-dom":"16.13.1","styled-components":"5.1.1","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"gitHead":"6f19a4d2cf4b6b49f055f79c4bface4a9d8d43ca","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.0-rc.4","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-AxfiC+vAA2CKFnrcRnvAJRBtYD9rXzWcHVo+t2Wc0bo0pwEstt+8SfJd6zszYTArADthNSnB0VJ7yy4ZUz2uyQ==","shasum":"99eb4483f835ec99a473996fa3b41727fec668c7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.0-rc.4.tgz","fileCount":55,"unpackedSize":624181,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfkqVUCRA9TVsSAnZWagAAdwkP/A3NllEbAwdrgWKfh7AV\npw75Ms4yqsY53yZCPrgF/CbpsLNgCQ8aWUvSc4GD9rf2dmxeW1oJrszvnxFn\nT6AKadeCJCIc2RKnCpc68ukuJUPVPxmKibghm25Dznko6FlSpbeQASaUBVrA\noq4jFCeWGv8RGN1gN4ii1d1vTU50OTskVC6luF4bR6C2GvjbkYpLI53oV/ks\nIdOhL8C5+KlzrjUgyk9m1k3FN+cFuzD2WlAM8nzGrBctha1LHsGox/xiZT/b\nZ06ACPC3FFnn42/8X8xHqZORceg0O79vNC8ZIqQRtAsCSy60atwqD3b95wSz\nEMaMuR0acYkDjQcKc2OKiyNj1kODYv00m7MWMuiqcxNRSydciEOYOQ0hc4ap\n/IVnHmCT0rm3n88kS2QQYBsKdeGbw25ANy8eIIdeO7njd52nElbXnCgDzqKp\n5CQW8Od/2e+2jwLLhRS/XUX3wMhPtU7vT8U18FsLIJ6cYaLPFb7IpJ/8fjzm\n39DYYlGp7Jai3SoqDdNO8huVid9PUuusOLzRXjIeSFWpdf6yHuSYkUqprxX7\nzdHih9KYZLagloNvv6Ji7lMVa16M0zPfsKEHVwq9DcC197SHO5c/NxB31eIn\nRghibWdty/pAEEwN5RsoJ1BInRcei0Nnadci0y1zz+ldDxvsCa8IHR8mQl+Q\n5QkW\r\n=0dr7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH7BWbSXfsbSGUYkpMYxRow7bDF0Ec8dtHqphCu9T39sAiAcAD3VxlsK4f+cLmbi3ebj2S5D83S3IiIGyhAQjGUCuw=="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.0-rc.4_1603446099511_0.11303347386645535"},"_hasShrinkwrap":false},"1.0.0":{"name":"@sberdevices/assistant-client","version":"1.0.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","react":"16.13.1","react-dom":"16.13.1","styled-components":"5.1.1","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"gitHead":"c4a078602e9313f1c69233d4b5f9e7075dd65087","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.0","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-F4PAytcxyPw5JCqDykh7Mkq95cOgpHLtgok8gnfTTk6pOtcbFSA7tbkovUrJfgoOrojVtl4GNz350cCn/BQv6Q==","shasum":"09b1c657f8132cec8d158abd6138066a516b1ec7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.0.tgz","fileCount":55,"unpackedSize":624176,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfksVBCRA9TVsSAnZWagAA4NEQAJbqk1W5+NrJ8pvK6KBZ\nMbW1Ku5j/koMCwK3811U/BWOljAJFh9bLjkvQv7D1WyfcPeZ84LPozGQc4ea\nUikBP1R/on59PCO5n2BAadWwpdYNkIw/VtS6ZCbpkkppxCLS5j9ATRaAatfk\n/cZAk2fBoDbjxyiXUWpolUItUeoIUMtp5jK9LTn+rQW6fNEaoLZgOYsEXzRc\nK8np1yL2Y/6TNxIAwPiLz/BXd0gLMHW+LgBGddHkxMQZmzQJlx1ck0Bau66O\nd++pl94cV5hcE4G8kEdr7E0n7pRj7MW+b+fcyPK5s1nvu4aMQ+6cCYwkWLH7\nhwCzcNN/j/Z+p3F8KZnwVrCREkKUdPEyVMWXruINWHUylqv+MxmWQxLvAhyG\n3ycqruHlbFb5VoSccw46HOKeZrxtoHOer+ysNQiy6KrzG3/4UdyhuNC3Kg1x\nSx+FRAgFTTDy4j4lp2Z0FMImgtbG5wASUOP9t2EZMFAK1g388Tt4X9I0ybRJ\nfdHLiY99Gq6j8f8FiDXmeZHCIcYOUlLeif6XoWL9nWqDRVsLcpfyxkC+G5QQ\nTKDqlNkVUrPT0h5KDEPvIxQzHHgqippZdrOJqhJ+gkGj9t6SQo9eiNnN1Gdi\n9OFtAagMF8MR6Q/163BGwkJsp8l5GMEpnvycoao7VNcjE1nsJ5EIciP7jTsz\njKSI\r\n=1xXi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC0+A1To9183A89b/lkQSWVh3gzaPripVazk+SgBizeWAIhALUvjHipL85t6cxqsHykSebv4T+USZtsULa/qy2KSeZg"}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.0_1603454272960_0.03289328115191026"},"_hasShrinkwrap":false},"1.0.1":{"name":"@sberdevices/assistant-client","version":"1.0.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","react":"16.13.1","react-dom":"16.13.1","styled-components":"5.1.1","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"gitHead":"8145db42f42200a9f82cc836d3906e251c2a5175","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.1","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-pDtebaRCxCeiQeOvrbPTfrbhJJpJK68iT0z9+Tgv77o+JLUPOjXCUw82bDgiCOm0aA8TXglCLcY9s2gGCavC8Q==","shasum":"1c37d8a6f00a8301b51e5f349f483c430c95f12c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.1.tgz","fileCount":55,"unpackedSize":624469,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJflsaZCRA9TVsSAnZWagAA0yYP/3IAAU1gK5mNjhQbTE0x\nJyG/wOsnR5Vh6wGCL7+wvRMg4RmwLIFMT/vOMe5zZUIRx04tWAwzZFnLwcyN\nHBadqEs00mxWJA7Qygzg3xzOpvOTw6zEqC3lxL4yvOn7q6V7VuwqzHBnnla+\nvzp1mu7I+F/RJvBm9c4khnelexlemRYZl5tadM872genbQqdMenQudyLZliL\nxV36GImqxkgr0BT69tD4rPisZM8L728wjqyeEKhsO+c8OCTlyjW+qoMj4/PS\nyUR0F1wXgDO+OkEbR40DORgBqmhhSfjFEVP3iZooEr+lfF1mZa8mMXGGH2qV\nfN9IzwfVrMhAud4b1vjDvkLi35F1C6K7hWpVoVUdBO75nhdhbgcNCOEcQ6uo\nV2THYBzvAXsuQqjE11gsbz5EhpRvq8/T6SVaJ0/S9U5p6oark3NW43ul5rBS\nmmAyQXKut8QVYNXrFKgE82W4IHyeKU5eiod0pIz0V0CuzJl8YABaQe9G5xXd\nxsYmvOVA/U7RFoduN6U7z8kqyXLQo+EZF4b790oxLCyte9OaDpjZzauGATdk\nLiQDNZBfurzlpF+3xg30aIIdiLXqP6plhsRl90luQD/mBJEM7/LdToEw2C0W\niggvr6a877CzTCpM2AfiuyrLZe39MCp1tjbeUFmMPxLgwXW353cu5GMJqMDx\nc/Lm\r\n=zKAn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCv4J1duUHWOusk90rUJ24/4CUzQj6C4h+5/0OvvfZkcAIhAII/Mxr4f27tozAOdESptCX0KrJcQlPTDNCt6nJOKTkO"}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.1_1603716761101_0.9424545613315036"},"_hasShrinkwrap":false},"1.0.2":{"name":"@sberdevices/assistant-client","version":"1.0.2","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/styled-components":"5.1.1","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0","styled-components":">=5.1.0"},"gitHead":"51a46d11e76019ff3e781ca44b38a783193aea17","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.2","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-vOFBQzatqt0fSEmxzW5Xo2uOlXuGnPTHmh3SyiE2al4Eu0zwVcYNXaFLweYlTWB/mVleTBXIuxfBXQoj18SD1A==","shasum":"63351ba6fd92315ef4633e781d2db8599cfcd622","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.2.tgz","fileCount":55,"unpackedSize":625430,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfmAn4CRA9TVsSAnZWagAAGQAP/1NH2tKP5a3e62pgm5zZ\nD5QyVCwFg7sDGULErOIlfOD5Pv1MbsYVi18F0IIBF7l5yqZ5Jlh7yBqIhsge\nXxoUckMeA+d31Ayny6Fq9n7thzAMt/APV1ruzCvckgEnwUFWUygWAyzwEj9z\nj7UamfPw1xzLz3g/wEmHDqaJ4WPF3wkSzwsU2+716VKuo7+6/f/A6aDVNqTk\njhDfjUE7ZCW5+J3CzI/DnElP0OaLS5pqN7yC39qstwj19Pq+aa68MXs/+sSj\nvyqZxUq1z/Say1yHOi6cF9ay/APrBEvacdW/7mXCaH7BFAtrJBTRPWgl93Ss\np69j5Gx7gjqWS8Z4gvGmSsqJzj3bjGywo8kOev5LPQXkweAzeYkYEGx6fMl1\nGNRcQp0dP7w+4sKvLC2Zgm1spw4OrB/pGrboYZlYRW8I0hexio5A5Nww/Dkf\nJQxhUhBZb6z5dKxJYw/JeXqYltJofDvBA3kP0o7zMp33Z4eE3VGVxzb3F9V/\ntpslCL3OePRPBH0RUcghmJx0AVOWNnMQiRuMujASa3ENmfhvlnUfllItJ8+c\nxH7jv9YSM3ObB92lp5FQQlvSrbp8N1Xr2ZGI8P02aTlbHWtmVMecoihNX6Ey\nKJXPoIIMdN8d4c+WuyabadAczeu4Tlz4NVBFiQYQp5uvKGGEjjLP6z9MYhia\n9Exd\r\n=e7DX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDTYQb9CKpyKYCXZlnTi9xIbnt8FinIuPAbvvyi2oKttgIhAOsX+Nd57ZYeQ+OzU9TI2NyUjay90Bm9H4deFeW7tDJi"}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.2_1603799544231_0.04334533764761295"},"_hasShrinkwrap":false},"1.0.3":{"name":"@sberdevices/assistant-client","version":"1.0.3","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"526f0f257036546f91d92297252f2708934fb443","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.3","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-T0kWC9BPBcqVPg26oNORlbUbVebF1E5MjdzCgRE7R7aMf/R3dfLUD5bJhz6deaDiDTH+cCsJGuVRYAACV3sdtg==","shasum":"c1a5cbc554a54c088a5f52a3375f5d388f99bb03","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.3.tgz","fileCount":57,"unpackedSize":625270,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfn83mCRA9TVsSAnZWagAAfeQP/0+6RywxrZmqkO2GBuM3\nGG7BDZjcGM0ml84gMOpVlJcd4wPliH0xUpnYqwItaZ7EbPU40DYR+/+aTViQ\nacPw1BmbbE80DX98Czz5fqffdNMM7KIYD6TDpdQ1wYa7ZX7LvOwIcVAEuTBj\nMm6B3E4c7HoP1r9i8JDGIc3g15WEeX8Zd2dhMZmoJdgk5jRRU/XBT3H6yV6c\nZwbs9Wjl0+MrOfjPI6siHadGLPD35Ai9GmrBSyMQa+oMgY9W0jZJjry1BQ4q\nmuelvtAmKXZ0M4Ovt6/UDuXnn8cIoRadFn1miOlWrj/xqFYUZEwsDHBdsqx9\nwjFYqB7gjQScs2Yg3aRcfjE9q5kT6/9eDQuC57miw6RbYkN1oC3iiJaMlxyp\no4XxkPlGVQZAYZla2CB3TTLA7uU5uM9twiUnmrJd4buu7piz3TLDH+D8OiQH\nyPOGfShXBzrZN6fIYm9RzwEIoNrCz8GtZdEAHjmaXpinpccgEYHMjxSG+3jH\nnqAv1ICk61uVWrRaRZQk6ywUp4NDMEnEDNz+3WxY/X5SYo3PhiXBsPIs0VMk\nS7lqNFDOAYttAz44KuOX9BpNLYdI0t1LYLq/o6i43IYj7NpSCBrVrPASXsUt\ny/EsAA1ZR9i1wPgWpMJ5alv2jGxJ0yJKSUXkpn44UrzsQOE9YeHxftbVW5Nj\nDTMD\r\n=USJD\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIARvoFR9LJWyc7Z+NytkqshXtnEUP+lyGX4QwyKf3ez4AiEA8RqqJIOcSvMynQxYEqwWexvZra5fBqM+C5DnHBrb+qw="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.3_1604308454017_0.9228813035231254"},"_hasShrinkwrap":false},"1.1.0-canary.28.0039888976b7c4d0699434907891c4e88b639e7e.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.0039888976b7c4d0699434907891c4e88b639e7e.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"0039888976b7c4d0699434907891c4e88b639e7e","readme":"![](\"https://user-images.githubusercontent.com/982072/97004635-0888a900-1546-11eb-8f25-283a0693608e.png\")
\n\n\n# SberDevices Assistant Client\n\nAssistant Client - это инструмент для тестирования и отладки СanvasApps c Виртуальным Ассистентом (ВА).\n\nAssistant Client интегрирует в WebView JS-код, который предоставляет биндинги к нативным методам на устройствах. В режиме локальной отладки и разработки Assistant Client эмулирует нативные методы, что позволяет запускать ВА в браузере.\n\nУстановка:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n## Quickstart\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n token: 'токен разработчика из Smartapp Studio', // Токен,\n initPhrase: 'Хочу попкорн', // фраза для запуска аппа\n getState,\n getRecoveryState,\n });\n }\n\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // подписка на команды ассистента, в т.ч. команда инициализации смартапа\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // отправка ServerAction\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), обязательный параметр `getState` - функция, которая возвращает актуальное состояние смартапа при каждом обращении к бэкенду. Используется в production среде на девайсах.\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), добавляет на экран браузера панель с голосовым ассистентом, подобно устройствам. Панель позволяет вводить команды с клавиатуры и голосом. Также активируется озвучка ассистента. Используется в development среде для локальной отладки и разработки.\n\n| Параметр | Dev only | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState\\* | [] | Функция, которая возвращает актуальное состояние смартапа. |\n| token\\* | [x] | Токен. |\n| initPhrase\\* | [x] | Фраза, которая запускает ваше приложение. |\n| getRecoveryState | [] | Функция, которая возвращает состояние смартаппа перед последним закрытием. |\n\n#### Панель ассистента\n\n\n\nПо-умолчанию, в режиме разработки, панель отрисовывается. Вы можете посылать ВА сообщения, используя текстовое поле ввода в нижней панели. Чтобы отправить голосовое сообщение, нажмите на иконку салюта.\n\n### AssistantClient\n\n\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n### getRecoveryState(): any\n\nВозвращает данные, сохраненные при последнем закрытии аппа на устройстве. Данные сохраняются при помощи вызова getRecoveryState, в момент закрытия аппа.\n\n#### on('start', cb: () => void): void\n\nПодписка на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nПодписка на событие получения данных от бэкенда.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет сервер-экшен, который будет передан бэкенду.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет колбек, возвращаюший актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет колбек, возвращающий объект, который будет доступен при следующем запуске приложения. Данные можно получить при вызове getRecoveryState.\n\n#### Формат объекта `AssistantAppState`\n\n\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. То, что происходит на экране у пользователя и как пользователь может взамодействовать с смартапа в конкретный момент времени - ответственность смартапа. Assistant Client, в данном случае, некий буфер, который хранит состояние и предоставляет его платформе и сценарию смартапа.\n\nКаждый раз, когда пользователь начинает говорить, Assistant Client вызывает коллбек getState, чтобы получить и передать бэкенду состояние экрана пользователя.\n\n```typescript\ninterface AssistantAppState {\n /* Любые данные, которые могут потребоваться Backend'у для принятия решений */\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n /* Список соответствий голосовых команд действиям в веб-приложении */\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n /* Порядковый номер элемента, назначается смартапом, уникален в рамках items */\n number?: number;\n /* Уникальный id элемента */\n id?: string;\n /* Ключевая фраза, которая должна приводить к данному действию */\n title?: string;\n /* Фразы-синонимы, которые должны быть расценены как данное действие */\n aliases?: string[];\n /* Сервер экшен, проксирует action обратно на бекэнд. */\n server_action?: AssistantServerAction;\n /* Экшен, выполяет действие от имени пользователя */\n action?: AssistantAction | { type: string };\n /* Дополнительные данные для бэкенда */\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенду нужно понимать что скрывается за единицей (какой элемент у пользователя пронумерован единицей). Ниже пример стейта, который позволяет понять бэкенду, что пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Кола' },\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Пиво', number: 3 }\n ]\n }\n}\n```\n\n#### Формат объекта `AssistantServerAction`\n\n\n\n`AssistantServerAction` - это любое сообщение, отправляемое от клиентской части приложения в бэкенд. Оно может быть как привязано к ui-элементу и приходить с бэка (в основном, для message-based аппов), так и формироваться самостоятельно фронтовой частью аппа при обработке событий внутри веб-вью аппа..\n\n```typescript\ninterface AssistantServerAction {\n /* Тип сервер-экшена */\n action_id: string;\n /* любые параметры */\n parameters?: Record;\n}\n```\n\n#### Формат объекта `AssistantCharacterCommand`\n\n\n\n`AssistantCharacterCommand` - информирует смартап о текущем ассистенте.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantNavigationCommand`\n\n\n\n`AssistantNavigationCommand` - команда навигации пользователя по смартапу. Большая часть навигационных команд может быть выполнена стандартным средствами Assistant Client. В платформе виртуального ассистента есть стандартные фразы, которые обрабатываются единым образом. Они обрабатываются и приходят одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n /* Тип команды */\n type: \"navigation\";\n /* Навигационная команда (направление навигации) */\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantSmartAppCommand`\n\n\n\n`AssistantSmartAppCommand` - это команда для передачи смартапу любых данных с бэкенда.\n\n```typescript\ninterface AssistantSmartAppCommand {\n /* Тип команды */\n type: \"smart_app_data\";\n /* Любые данные, которые нужны смартапу */\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n## Разрешения устройств\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого, необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Рекомендуется настроить эти разрешения на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n## FAQ\n### Как получить токен?\nЗаведите аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/) и создайте приложение типа CanvasApp. Токен доступен во вкладке «Настройка профиля» в секции «Auth Token».\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.0039888976b7c4d0699434907891c4e88b639e7e.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-hZkepusOjBh/BnZMpTsZPwhU3pqW7ygI2/p61Yh8YcCVqt6XpzwqKtV+uorg7KbnMAjgkx41crcX6OPcjRo44Q==","shasum":"478731113010f896cba57bf7d3896ea09ba90c60","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.0039888976b7c4d0699434907891c4e88b639e7e.0.tgz","fileCount":57,"unpackedSize":625820,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfoPQfCRA9TVsSAnZWagAAPDEP/1lK11v9kGvgsAgT1OvK\nzYdrTZFFAk0VaBNvAbYwd4LSIGaMlsuSe6XrXho8t5IL2Ar/dbY1rDrqEBg2\nDhhaFsz/Vf0L/5+9fMD/qYveUkQdncxSWjuU9gzsg5yJ/QZofU8ZYvlCekeZ\n1Xfl6VCWbL0JEe06XKrdocaEV39kPFDOMVNV7xhAuMHG4ttbNtbQbk5Jz2av\nCgwpm2Ox4DuL0jwrToBwp0XomHJ0tlLN8cCC51rcwBMZgrbx3mvnpgtvvteF\n4KV8/S1GHeq2ZFuB0iJD1+sTR0USIBCuTC6Isb5k9UZNgFP+gMeFzpG3xejP\nth4nq9PKFyi74FdY8Ua1rdhS+Bp1fAKpqStHWULFy7raWAUNTbmRQfivjcxN\nC9lZvCNUqiBzKY8iaylYFPVA5gdeMqetdR14HxdYG+PF9HJPTfN32SubCFwD\nebEshYteDVMfLPdEHKbBMcq3RgsyDSSVgk6UoFYb0eyKsTMXMuN02wtR89DC\nYrZQza5FeznNNOjL9a4hpHGUB0xCmUCUJhoXnsWlgS90nC9q7raqYUOvNdgC\nEWmsn6AM4k+g41RNSkQ9C/5YkMStpRy50/RyZnHdfHxrvHRMLaDH8BDaEC21\nfNd/C0V5flLeEhPDQaP+eey0uDjvTINXjHRRaRZ9RRD4pPmaqxqrRahkBSoS\nwyEQ\r\n=Y6nI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBHBdQD6JYC58D0pbqTFmIikjOdlBMqF2JbjKXaYLYArAiAyt0VQunzmd3kpV5zpWxVjZG/4WSDeknvKcCiircY3TQ=="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.0039888976b7c4d0699434907891c4e88b639e7e.0_1604383774563_0.27709841998685225"},"_hasShrinkwrap":false},"1.1.0-canary.28.e8024722f14a1cd664ff356e2410446479f3d54b.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.e8024722f14a1cd664ff356e2410446479f3d54b.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"e8024722f14a1cd664ff356e2410446479f3d54b","readme":"\n\n\n# SberDevices Assistant Client\n\nAssistant Client - это инструмент для тестирования и отладки СanvasApps c Виртуальным Ассистентом (ВА).\n\nAssistant Client интегрирует в WebView JS-код, который предоставляет биндинги к нативным методам на устройствах. В режиме локальной отладки и разработки Assistant Client эмулирует нативные методы, что позволяет запускать ВА в браузере.\n\nУстановка:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n## Quickstart\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n token: 'токен разработчика из Smartapp Studio', // Токен,\n initPhrase: 'Хочу попкорн', // фраза для запуска аппа\n getState,\n getRecoveryState,\n });\n }\n\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // подписка на команды ассистента, в т.ч. команда инициализации смартапа\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // отправка ServerAction\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), обязательный параметр `getState` - функция, которая возвращает актуальное состояние смартапа при каждом обращении к бэкенду. Используется в production среде на девайсах.\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), добавляет на экран браузера панель с голосовым ассистентом, подобно устройствам. Панель позволяет вводить команды с клавиатуры и голосом. Также активируется озвучка ассистента. Используется в development среде для локальной отладки и разработки.\n\n| Параметр | Dev only | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState\\* | [] | Функция, которая возвращает актуальное состояние смартапа. |\n| token\\* | [x] | Токен. |\n| initPhrase\\* | [x] | Фраза, которая запускает ваше приложение. |\n| getRecoveryState | [] | Функция, которая возвращает состояние смартаппа перед последним закрытием. |\n\n#### Панель ассистента\n\n\n\nПо-умолчанию, в режиме разработки, панель отрисовывается. Вы можете посылать ВА сообщения, используя текстовое поле ввода в нижней панели. Чтобы отправить голосовое сообщение, нажмите на иконку салюта.\n\n### AssistantClient\n\n\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n### getRecoveryState(): any\n\nВозвращает данные, сохраненные при последнем закрытии аппа на устройстве. Данные сохраняются при помощи вызова getRecoveryState, в момент закрытия аппа.\n\n#### on('start', cb: () => void): void\n\nПодписка на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nПодписка на событие получения данных от бэкенда.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет сервер-экшен, который будет передан бэкенду.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет колбек, возвращаюший актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет колбек, возвращающий объект, который будет доступен при следующем запуске приложения. Данные можно получить при вызове getRecoveryState.\n\n#### Формат объекта `AssistantAppState`\n\n\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. То, что происходит на экране у пользователя и как пользователь может взамодействовать с смартапа в конкретный момент времени - ответственность смартапа. Assistant Client, в данном случае, некий буфер, который хранит состояние и предоставляет его платформе и сценарию смартапа.\n\nКаждый раз, когда пользователь начинает говорить, Assistant Client вызывает коллбек getState, чтобы получить и передать бэкенду состояние экрана пользователя.\n\n```typescript\ninterface AssistantAppState {\n /* Любые данные, которые могут потребоваться Backend'у для принятия решений */\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n /* Список соответствий голосовых команд действиям в веб-приложении */\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n /* Порядковый номер элемента, назначается смартапом, уникален в рамках items */\n number?: number;\n /* Уникальный id элемента */\n id?: string;\n /* Ключевая фраза, которая должна приводить к данному действию */\n title?: string;\n /* Фразы-синонимы, которые должны быть расценены как данное действие */\n aliases?: string[];\n /* Сервер экшен, проксирует action обратно на бекэнд. */\n server_action?: AssistantServerAction;\n /* Экшен, выполяет действие от имени пользователя */\n action?: AssistantAction | { type: string };\n /* Дополнительные данные для бэкенда */\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенду нужно понимать что скрывается за единицей (какой элемент у пользователя пронумерован единицей). Ниже пример стейта, который позволяет понять бэкенду, что пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Кола' },\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Пиво', number: 3 }\n ]\n }\n}\n```\n\n#### Формат объекта `AssistantServerAction`\n\n\n\n`AssistantServerAction` - это любое сообщение, отправляемое от клиентской части приложения в бэкенд. Оно может быть как привязано к ui-элементу и приходить с бэка (в основном, для message-based аппов), так и формироваться самостоятельно фронтовой частью аппа при обработке событий внутри веб-вью аппа..\n\n```typescript\ninterface AssistantServerAction {\n /* Тип сервер-экшена */\n action_id: string;\n /* любые параметры */\n parameters?: Record;\n}\n```\n\n#### Формат объекта `AssistantCharacterCommand`\n\n\n\n`AssistantCharacterCommand` - информирует смартап о текущем ассистенте.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantNavigationCommand`\n\n\n\n`AssistantNavigationCommand` - команда навигации пользователя по смартапу. Большая часть навигационных команд может быть выполнена стандартным средствами Assistant Client. В платформе виртуального ассистента есть стандартные фразы, которые обрабатываются единым образом. Они обрабатываются и приходят одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n /* Тип команды */\n type: \"navigation\";\n /* Навигационная команда (направление навигации) */\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantSmartAppCommand`\n\n\n\n`AssistantSmartAppCommand` - это команда для передачи смартапу любых данных с бэкенда.\n\n```typescript\ninterface AssistantSmartAppCommand {\n /* Тип команды */\n type: \"smart_app_data\";\n /* Любые данные, которые нужны смартапу */\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n## Разрешения устройств\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого, необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Рекомендуется настроить эти разрешения на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n## FAQ\n### Как получить токен?\nЗаведите аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/) и создайте приложение типа CanvasApp. Токен доступен во вкладке «Настройка профиля» в секции «Auth Token».\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.e8024722f14a1cd664ff356e2410446479f3d54b.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-3+BqHzLeYNEqg1C/GdnDn5pLCTagYDFl757dzfUUXYGSZRRMn0CMyMKAHd4UC9I7On8jIvlivr5bZbSZBPCPQA==","shasum":"5b27b70b16c83bfec491ad3f52aade457f94333e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.e8024722f14a1cd664ff356e2410446479f3d54b.0.tgz","fileCount":57,"unpackedSize":625820,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfoPeSCRA9TVsSAnZWagAAB6MP/0xDZl7IouF0+QoHI6SG\nt6Go08e5HuALrj8W4KsVJFatJPy9uBqYjElBEJqwx2nYKHFUfwHpzBWOLkWZ\nRDm9yEm0fGrIPDZvocgsDonZw4DorPaL3pizjIZrd/LIVdrNcyVafrlJYEfX\ngrDF1ggFuU7pPPhcV/lzWAJvhP50SSq0fAlepTtIM5wl0ABZl99r+8nPFB1Q\nICk4/xGVU8A4NH2J9RGK5/8JSObePxPcbVfWlZQ8l/ETCtW4Q5V0GZQ8Ysc+\ndeK7hO68MF81Oe6uIYU+u+86Vv0clAfCqGsPDIqT5s081v6sxkJV89vPIaxn\nECwgZ0bTRCS+R1ZU1pAlhPUpAr3qDWxDfrpufsCZ04F3C6iNhdFGLIF8hTte\nDNddMMuwtS8TJ7TOFkdjZ5SXEgF15rNvBy2X1CYcZFD5n+OmwQFUyw3Id+MN\nMKkcXkFgOWqb7h7VvzGQnLlqhPyNBuIFcfzgUCvoGJQYLcVP7j5Ibb6Tl0QU\nKsJzAHvAX7VgyYlvQadF0QCBiMZHLdIMNjuK1wqWyl9B+LHp2+EMEffcYiqq\nbc4z7NIHqH9LCbuOX3NsZ7Pn43+VF7o22xh8Qx2wf5xMvIR2LyrIRSKdRYE1\nFU7PfXORKYmKVJ/HHXsIsc7iu/CIng80gBbGwNO+vd4r2sh7qVbkjvvGbphX\nowPg\r\n=qo3u\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF9T9DWoEwSKOUDPROc+WDvnhehA4CHBp/3NCOXhkFX8AiEAgOUp8NmlcHBve4Yedvey6rKgx44LL8cTCm639umyaBA="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.e8024722f14a1cd664ff356e2410446479f3d54b.0_1604384658324_0.5486407543055407"},"_hasShrinkwrap":false},"1.1.0-canary.28.ff63d06e164fa2ddc145ac23fdbbddeb98343c9f.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.ff63d06e164fa2ddc145ac23fdbbddeb98343c9f.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"ff63d06e164fa2ddc145ac23fdbbddeb98343c9f","readme":"\n\n\n# SberDevices Assistant Client\n\nAssistant Client - это инструмент для тестирования и отладки СanvasApps c Виртуальным Ассистентом (ВА).\n\nAssistant Client интегрирует в WebView JS-код, который предоставляет биндинги к нативным методам на устройствах. В режиме локальной отладки и разработки Assistant Client эмулирует нативные методы, что позволяет запускать ВА в браузере.\n\nУстановка:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n## Quickstart\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n token: 'токен разработчика из Smartapp Studio', // Токен,\n initPhrase: 'Хочу попкорн', // фраза для запуска аппа\n getState,\n getRecoveryState,\n });\n }\n\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // подписка на команды ассистента, в т.ч. команда инициализации смартапа\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // отправка ServerAction\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), обязательный параметр `getState` - функция, которая возвращает актуальное состояние смартапа при каждом обращении к бэкенду. Используется в production среде на девайсах.\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), добавляет на экран браузера панель с голосовым ассистентом, подобно устройствам. Панель позволяет вводить команды с клавиатуры и голосом. Также активируется озвучка ассистента. Используется в development среде для локальной отладки и разработки.\n\n| Параметр | Dev only | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState\\* | [] | Функция, которая возвращает актуальное состояние смартапа. |\n| token\\* | [x] | Токен. |\n| initPhrase\\* | [x] | Фраза, которая запускает ваше приложение. |\n| getRecoveryState | [] | Функция, которая возвращает состояние смартаппа перед последним закрытием. |\n\n#### Панель ассистента\n\n\n\nПо-умолчанию, в режиме разработки, панель отрисовывается. Вы можете посылать ВА сообщения, используя текстовое поле ввода в нижней панели. Чтобы отправить голосовое сообщение, нажмите на иконку салюта.\n\n### AssistantClient\n\n\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n### getRecoveryState(): any\n\nВозвращает данные, сохраненные при последнем закрытии аппа на устройстве. Данные сохраняются при помощи вызова getRecoveryState, в момент закрытия аппа.\n\n#### on('start', cb: () => void): void\n\nПодписка на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nПодписка на событие получения данных от бэкенда.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет сервер-экшен, который будет передан бэкенду.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет колбек, возвращаюший актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет колбек, возвращающий объект, который будет доступен при следующем запуске приложения. Данные можно получить при вызове getRecoveryState.\n\n#### Формат объекта `AssistantAppState`\n\n\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. То, что происходит на экране у пользователя и как пользователь может взамодействовать с смартапа в конкретный момент времени - ответственность смартапа. Assistant Client, в данном случае, некий буфер, который хранит состояние и предоставляет его платформе и сценарию смартапа.\n\nКаждый раз, когда пользователь начинает говорить, Assistant Client вызывает коллбек getState, чтобы получить и передать бэкенду состояние экрана пользователя.\n\n```typescript\ninterface AssistantAppState {\n /* Любые данные, которые могут потребоваться Backend'у для принятия решений */\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n /* Список соответствий голосовых команд действиям в веб-приложении */\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n /* Порядковый номер элемента, назначается смартапом, уникален в рамках items */\n number?: number;\n /* Уникальный id элемента */\n id?: string;\n /* Ключевая фраза, которая должна приводить к данному действию */\n title?: string;\n /* Фразы-синонимы, которые должны быть расценены как данное действие */\n aliases?: string[];\n /* Сервер экшен, проксирует action обратно на бекэнд. */\n server_action?: AssistantServerAction;\n /* Экшен, выполяет действие от имени пользователя */\n action?: AssistantAction | { type: string };\n /* Дополнительные данные для бэкенда */\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенду нужно понимать что скрывается за единицей (какой элемент у пользователя пронумерован единицей). Ниже пример стейта, который позволяет понять бэкенду, что пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Кола' },\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Пиво', number: 3 }\n ]\n }\n}\n```\n\n#### Формат объекта `AssistantServerAction`\n\n\n\n`AssistantServerAction` - это любое сообщение, отправляемое от клиентской части приложения в бэкенд. Оно может быть как привязано к ui-элементу и приходить с бэка (в основном, для message-based аппов), так и формироваться самостоятельно фронтовой частью аппа при обработке событий внутри веб-вью аппа..\n\n```typescript\ninterface AssistantServerAction {\n /* Тип сервер-экшена */\n action_id: string;\n /* любые параметры */\n parameters?: Record;\n}\n```\n\n#### Формат объекта `AssistantCharacterCommand`\n\n\n\n`AssistantCharacterCommand` - информирует смартап о текущем ассистенте.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantNavigationCommand`\n\n\n\n`AssistantNavigationCommand` - команда навигации пользователя по смартапу. Большая часть навигационных команд может быть выполнена стандартным средствами Assistant Client. В платформе виртуального ассистента есть стандартные фразы, которые обрабатываются единым образом. Они обрабатываются и приходят одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n /* Тип команды */\n type: \"navigation\";\n /* Навигационная команда (направление навигации) */\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantSmartAppCommand`\n\n\n\n`AssistantSmartAppCommand` - это команда для передачи смартапу любых данных с бэкенда.\n\n```typescript\ninterface AssistantSmartAppCommand {\n /* Тип команды */\n type: \"smart_app_data\";\n /* Любые данные, которые нужны смартапу */\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n## Разрешения устройств\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого, необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Рекомендуется настроить эти разрешения на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n## FAQ\n### Как получить токен?\nЗаведите аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/) и создайте приложение типа CanvasApp. Токен доступен во вкладке «Настройка профиля» в секции «Auth Token».\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.ff63d06e164fa2ddc145ac23fdbbddeb98343c9f.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-0S51v5clS5oFmHkRMbfJlB/rT1/SJ1KXh7P33CvgTpnTEA2CnuuHYNqP8V4nqnJEVIOCu2NdJAPQC51ADrJumQ==","shasum":"7302405de98ea9cb426cc64732dff0d476cd2c5e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.ff63d06e164fa2ddc145ac23fdbbddeb98343c9f.0.tgz","fileCount":57,"unpackedSize":625853,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfoPikCRA9TVsSAnZWagAAO7AQAJQcmHLbxmvgoZy+Y8Bn\nZyk8NUoNh8Q1TTuO86Nf1E+N5wsP9FhCDe9MLVFBtBBlW2RuLKZLFKt7p/6Q\nvm3b7+G/j9kDqFLYMBLecqtqwuaRg0L9Ac03bbqaluuktL2/O6nG4p0bfCnn\nb4xu5nXBe32X3X7ePqwVvbM8a84oRuWY1FHlTZg/6d/UXVyRKF2YMuzdIRSk\nk8elMPPyYsfaghSfsLTzGuP2lY0uwGlFGJc8mdZpIzGM2nk31kGU3xf6CgOf\nSPV0rBPoa+k3WI6xoOfikOAjk3+Ua85k3S2Ko0/RTOJoCjdCNziWMFi9tYsb\nIsdv7NLROQrbU29G0KrwdgnCpg9nwaJkQWw9zGygDnPQG7bFMNClXenF6kef\nw19AZUoofR0LDyHX/5raAwkmNg780l0OIPNMG68tJnPJ/CFfn7XkskG3IYSQ\nU8o637Wq6IZNL32+D1xvpqp+FaaNqEaIvg95hte2/NGLnt+HhryF0gEXZVAt\nq7BXw63WDFt160D3QLdO/MAFj6Q3T01xWYOGbhIPdpVySXySdIqam6po/88F\n86N7gwdqgi6xD+jaFIU8isHIeLjShtTE3GOXliLpYJl6Si245krfB9ilNkh4\nFe03Nr7AcYAazLfPR8aRZB/GgruKpPh5P2Mg+YRrLL6omEXUX9qm/ClRa4Nq\nbV7S\r\n=eg7u\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFcqXafXMkDZyu1HxKBn8CsCtH5js6WaodGK2yZ6wTU1AiEA18uoScSO+n4VfBvIONkRYJwDwOfWcBdCfFXeGmNznsg="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.ff63d06e164fa2ddc145ac23fdbbddeb98343c9f.0_1604384931904_0.8921512588495066"},"_hasShrinkwrap":false},"1.1.0-canary.28.2b33222b202dc51c90c49b88daeddb053aa47458.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.2b33222b202dc51c90c49b88daeddb053aa47458.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"2b33222b202dc51c90c49b88daeddb053aa47458","readme":"\n\n\n# SberDevices Assistant Client\n\nAssistant Client - это инструмент для тестирования и отладки СanvasApps c Виртуальным Ассистентом (ВА).\n\nAssistant Client интегрирует в WebView JS-код, который предоставляет биндинги к нативным методам на устройствах. В режиме локальной отладки и разработки Assistant Client эмулирует нативные методы, что позволяет запускать ВА в браузере.\n\nУстановка:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n## Quickstart\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n token: 'токен разработчика из Smartapp Studio', // Токен,\n initPhrase: 'Хочу попкорн', // фраза для запуска аппа\n getState,\n getRecoveryState,\n });\n }\n\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // подписка на команды ассистента, в т.ч. команда инициализации смартапа\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // отправка ServerAction\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), обязательный параметр `getState` - функция, которая возвращает актуальное состояние смартапа при каждом обращении к бэкенду. Используется в production среде на девайсах.\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient), добавляет на экран браузера панель с голосовым ассистентом, подобно устройствам. Панель позволяет вводить команды с клавиатуры и голосом. Также активируется озвучка ассистента. Используется в development среде для локальной отладки и разработки.\n\n| Параметр | Dev only | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState\\* | [] | Функция, которая возвращает актуальное состояние смартапа. |\n| token\\* | [x] | Токен. |\n| initPhrase\\* | [x] | Фраза, которая запускает ваше приложение. |\n| getRecoveryState | [] | Функция, которая возвращает состояние смартаппа перед последним закрытием. |\n\n#### Панель ассистента\n\n\n\nПо-умолчанию, в режиме разработки, панель отрисовывается. Вы можете посылать ВА сообщения, используя текстовое поле ввода в нижней панели. Чтобы отправить голосовое сообщение, нажмите на иконку салюта.\n\n### AssistantClient\n\n\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n### getRecoveryState(): any\n\nВозвращает данные, сохраненные при последнем закрытии аппа на устройстве. Данные сохраняются при помощи вызова getRecoveryState, в момент закрытия аппа.\n\n#### on('start', cb: () => void): void\n\nПодписка на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nПодписка на событие получения данных от бэкенда.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет сервер-экшен, который будет передан бэкенду.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет колбек, возвращаюший актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет колбек, возвращающий объект, который будет доступен при следующем запуске приложения. Данные можно получить при вызове getRecoveryState.\n\n#### Формат объекта `AssistantAppState`\n\n\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. То, что происходит на экране у пользователя и как пользователь может взамодействовать с смартапа в конкретный момент времени - ответственность смартапа. Assistant Client, в данном случае, некий буфер, который хранит состояние и предоставляет его платформе и сценарию смартапа.\n\nКаждый раз, когда пользователь начинает говорить, Assistant Client вызывает коллбек getState, чтобы получить и передать бэкенду состояние экрана пользователя.\n\n```typescript\ninterface AssistantAppState {\n /* Любые данные, которые могут потребоваться Backend'у для принятия решений */\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n /* Список соответствий голосовых команд действиям в веб-приложении */\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n /* Порядковый номер элемента, назначается смартапом, уникален в рамках items */\n number?: number;\n /* Уникальный id элемента */\n id?: string;\n /* Ключевая фраза, которая должна приводить к данному действию */\n title?: string;\n /* Фразы-синонимы, которые должны быть расценены как данное действие */\n aliases?: string[];\n /* Сервер экшен, проксирует action обратно на бекэнд. */\n server_action?: AssistantServerAction;\n /* Экшен, выполяет действие от имени пользователя */\n action?: AssistantAction | { type: string };\n /* Дополнительные данные для бэкенда */\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенду нужно понимать что скрывается за единицей (какой элемент у пользователя пронумерован единицей). Ниже пример стейта, который позволяет понять бэкенду, что пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Кола' },\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Пиво', number: 3 }\n ]\n }\n}\n```\n\n#### Формат объекта `AssistantServerAction`\n\n\n\n`AssistantServerAction` - это любое сообщение, отправляемое от клиентской части приложения в бэкенд. Оно может быть как привязано к ui-элементу и приходить с бэка (в основном, для message-based аппов), так и формироваться самостоятельно фронтовой частью аппа при обработке событий внутри веб-вью аппа..\n\n```typescript\ninterface AssistantServerAction {\n /* Тип сервер-экшена */\n action_id: string;\n /* любые параметры */\n parameters?: Record;\n}\n```\n\n#### Формат объекта `AssistantCharacterCommand`\n\n\n\n`AssistantCharacterCommand` - информирует смартап о текущем ассистенте.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantNavigationCommand`\n\n\n\n`AssistantNavigationCommand` - команда навигации пользователя по смартапу. Большая часть навигационных команд может быть выполнена стандартным средствами Assistant Client. В платформе виртуального ассистента есть стандартные фразы, которые обрабатываются единым образом. Они обрабатываются и приходят одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n /* Тип команды */\n type: \"navigation\";\n /* Навигационная команда (направление навигации) */\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n#### Формат объекта `AssistantSmartAppCommand`\n\n\n\n`AssistantSmartAppCommand` - это команда для передачи смартапу любых данных с бэкенда.\n\n```typescript\ninterface AssistantSmartAppCommand {\n /* Тип команды */\n type: \"smart_app_data\";\n /* Любые данные, которые нужны смартапу */\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n## Разрешения устройств\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого, необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Рекомендуется настроить эти разрешения на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n## FAQ\n### Как получить токен?\nЗаведите аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/) и создайте приложение типа CanvasApp. Токен доступен во вкладке «Настройка профиля» в секции «Auth Token».\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.2b33222b202dc51c90c49b88daeddb053aa47458.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-xTB6U1fiON9NTxfdPPD3m2ABGddeDucDAYSfDTkoLTdWKKMDcZWhkLWm8/+WDAUpxIOv5GF3MU4XT4cvoq74IQ==","shasum":"f2f792f3125d48ecc4210df21c6896adc28bb0db","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.2b33222b202dc51c90c49b88daeddb053aa47458.0.tgz","fileCount":57,"unpackedSize":625870,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfoUTECRA9TVsSAnZWagAAKSwP/RElhEGAMWZ9b+9LGHWS\nGY/nuxx9XsGnBE00GdPhIpuApWMIsJ/zYaHZx+OFYTfpKCfazzbZDqHEfnO+\njn4cj0Jp8NAv+SjMQ90JX25ygWhifwX/YGhmyCd9n1sBHoGXc1RMrfLpV0Si\n5e/hn2NIXOx39ciSVNEHnCTk4pI55eToXFMG00I/S5xGHGkrfRIRtyD+hvMg\n2J1RCr8/bO2lVTHZji3n7ALnrVztXb8sTwnzWbdvpb5lMRmTH5nfjnyVA7dN\nSV//Alw32jA9lsovCrN+OVUMGnasENd8+X5XH6O/+Ifimq8b29jz9hjibcrP\n/9BOPQcroe9CqjVjp4xFAUlIYmKJ+0UVPeO3s++G8h+o8V5v68b8FeGeTcJW\nP4mEFol8ZJxV9rvqCyit0DEZ052FiH3ADbjZm9ynLWiE+e6qGEwGKMl+kC+q\nZIzh5Bav2ENxH5+Kt86vYkdKNIcn6gPaEKsijCH84ZaQrNz4xlprixllNp7M\nZaBVk1c4MJ1E4/bMtxCWgO3i2pe2V7F1RnVobW+hoZyxJ8y5p/9Xbpfwq9aU\neEgF33QsZuGVSGP6/bBJTvgLAnLJB6lsWhzAMQD+5g1Z59o6gd3pINi+V8jL\nrlcuOZVdDCBXYwx9m3Q9RNKt+HZWp7qcZq64F+7/S80p26c7ttn5JGPWU41e\nH3KS\r\n=zFLP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDSrIzweoGxGP1MW7DVGnOohtNhH2Zfaou2TZmaSKOoMgIgBmDvWNNw6IA/fEkCzhEskhj26j7LocKJYHk/TUERtKk="}]},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.2b33222b202dc51c90c49b88daeddb053aa47458.0_1604404420270_0.7569074510855207"},"_hasShrinkwrap":false},"1.1.0-canary.28.c89484a6f50a3216ceb49b7e8f9b0c337de8b899.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.c89484a6f50a3216ceb49b7e8f9b0c337de8b899.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"c89484a6f50a3216ceb49b7e8f9b0c337de8b899","readme":"\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер. \n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#Пример)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [getInitialData](#getInitialData) \n * [getRecoveryState](#getRecoveryState)\n * [Форматы объектов](#Форматы)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand) \n * [Требования](#Требования)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp). \n3. Получить токен в Кабинете разработчика и передать его в запросе. \n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token', \n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн', \n // Функция, которая возвращает текущее состояние приложения\n getState, \n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState, \n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState }); \n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа. \n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\" \n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд. \n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода; \n* голосовые сообщения через кнопку \"Салют\". \n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n\n### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов \n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя. \nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом \n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений. \n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды \n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.c89484a6f50a3216ceb49b7e8f9b0c337de8b899.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Uvc+nN7jd5Z//C/ptySfT28M1kuNbjAn1hb8Gz3+60EhTvm2/wCvAKkWtMthqQ1a2e1D5tZQlRRPs4j8udB8fQ==","shasum":"7bebc94ad5e449fe9652168c5f27df7a6e6cfaf1","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.c89484a6f50a3216ceb49b7e8f9b0c337de8b899.0.tgz","fileCount":57,"unpackedSize":628699,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfo7YZCRA9TVsSAnZWagAAWGsP/0f/gQAGs/d78pcwV2PO\n/1ID+3mlWLjZQRxbSnERePCvqYVv3f2hupPvtEeJbs0sFsXHJoiZ4dGdaTmn\nvs9kHdfrx2VkCdvCE4FsIVtAkJU2fwpBkDV86MTVJUtv+ZFQJZ72GMcM5kW4\nlL7mvh5vNU++yhaPP0OtyOg5QNbW/MSuBLNAjPvaKwVWjEExSTkP8b4Qbibl\niu61vHhxDSss5Md50kiEPGYnfqsoB5QylFJKmzfRK74l85LJnaAO6KYEbLE4\nFeXFHw78qmqNIGPe9xzXUlY4nqR77Z3aySkq4egRrKEhjXpEAgL5iTSm1S+D\nv/34wdwLBLdsD3UVxUOS+6VQaSAtRXN2IKHmxLYXRndca1qhkfa7wA/LRBy5\nnKXQwb4WlWxn6/hMSIik9nZQLc7HzAavaOgA/DMSJsgMdqrTr7IypcKysLrR\n7+ZbneM9pun7VaVGJJTnNOFh/0LnxRtGGVN9/rThP7+Wx8n2iqbLXp1+OIWh\n1xwaRmWUgILnrgRYc3eZdqXPmY7SqDBbs52Gu6xxEcNtVRsElNFR2SwvDG7/\nZqfpbS8y2ctX0w81F3HEJQC6ZbLfSPrBuJlHYxPMD1PWeiosg4QNvhPFyhWK\nxXxAvlIR0t1DP7XQAWweWxDEDuy4QsXWUbJNRoymVVkoF/hleSflycPHkXBZ\nza/m\r\n=5g2v\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAekG29/ydcW79848EzvL0R2jRw1EA2Ys1vCKCEcEXD0AiEA6nTGuurjjYTIFqB2aAPmiuB8fmq8NbUSSyKVCDeqIsw="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.c89484a6f50a3216ceb49b7e8f9b0c337de8b899.0_1604564505121_0.3005741654458993"},"_hasShrinkwrap":false},"1.1.0-canary.28.7e205355c78b9375dbc6f799cf47f536201dfb5e.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.7e205355c78b9375dbc6f799cf47f536201dfb5e.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"7e205355c78b9375dbc6f799cf47f536201dfb5e","readme":"\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер. \n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#Пример)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [getInitialData](#getInitialData) \n * [getRecoveryState](#getRecoveryState)\n * [Форматы объектов](#Форматы)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand) \n * [Требования](#Требования)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp). \n3. Получить токен в Кабинете разработчика и передать его в запросе. \n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token', \n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн', \n // Функция, которая возвращает текущее состояние приложения\n getState, \n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState, \n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState }); \n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа. \n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\" \n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд. \n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода; \n* голосовые сообщения через кнопку \"Салют\". \n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n\n### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов \n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя. \nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом \n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений. \n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды \n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.7e205355c78b9375dbc6f799cf47f536201dfb5e.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-5oieLqb/c7b8b8kr0KjzhnCbbl9ay4/3wtk48j7uWraLmQTcfjKqZCy7sYYOSJJ96ik1uoeylpHptiiQZkmLFg==","shasum":"f01aaebb90e9c42402f3ee79efe1cf881fbac5c4","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.7e205355c78b9375dbc6f799cf47f536201dfb5e.0.tgz","fileCount":57,"unpackedSize":628699,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfo7dICRA9TVsSAnZWagAASH8P/0QDDXE3z+V6XKYvMrVv\nwuM/bieGgxdJc/SCok3gXQjGFvptxa1cbFff83LXUXcsJtgh4B8zY3GskFN3\nDeEQORvYZXkKYaTSjB78vZWBeQDmT5cap/mTHH1SQPopvSlAPFwWBZcU5XY0\nbf4Bil2mlrBWBe9Ku7/C0uv5infBAMJUmdf/xcOnTg0fv+b6Vb5AXMA/1qd3\nekTbu7TMmCgppwrTnFC1yUDnkRav5bmjhKlc7MvuSPkWim7B25MnMF5HJnqG\nf1JfzuhYHgLHn83YY1qi8JVB7T1wYk6y1bp11ewOz7/5D8sL6kmACHnjebXt\ndjUwZFGTKp4QF3laEadU5cGl+rZAtnG0L8A8SDzlIE/AEhfqk+LHFftXGOax\ng2NP+wVtH5Iz1dgzPZvrbrOGWgsd0/xqlc38ZTFnaXYWxwCAnSbniDN+8Nja\nA5TPeqUNhIVtdEplH2rxwp8r3JJOIOOt6brTk8yHXt42+vEiF82CqZefiBtX\nGE7Znzcg2AAQxleninF9EuU5vigKQMYKbJ/agAlUONeGkoYz/PIh2mkEx/ge\nAs8cQZqg4ppeGxkN15cf2jSteJ2rr2Yb3Pc3CO8XRVkg2MEsKv9gVELqF/wj\nIFl4MuXE1Pj+/76mgaQvlbBxVlPgbpeVkparkWmDK3qzT5x8JjBbqW+D609M\nU8Pl\r\n=sQPj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD3HnzHPO2BwHSKiclWHsUqBNtg3/v+Vu54O6+F83yxLAIhALu3itJeEIZeMVW2QM6cKQMJM2Bh0/VVw+Qs0xfyZxKt"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.7e205355c78b9375dbc6f799cf47f536201dfb5e.0_1604564807588_0.5106497020525689"},"_hasShrinkwrap":false},"1.1.0-canary.28.13b9cb7b0ded987d2540334b42c530f888514d74.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.13b9cb7b0ded987d2540334b42c530f888514d74.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"13b9cb7b0ded987d2540334b42c530f888514d74","readme":"\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер. \n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#Пример)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [getInitialData](#getInitialData) \n * [getRecoveryState](#getRecoveryState)\n * [Форматы объектов](#Форматы)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand) \n * [Требования](#Требования)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp). \n3. Получить токен в Кабинете разработчика и передать его в запросе. \n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token', \n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн', \n // Функция, которая возвращает текущее состояние приложения\n getState, \n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState, \n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState }); \n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа. \n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\" \n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд. \n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода; \n* голосовые сообщения через кнопку \"Салют\". \n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n\n### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов \n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя. \nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом \n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений. \n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды \n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.13b9cb7b0ded987d2540334b42c530f888514d74.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-/kG1N4B3GAqw26cj7ITJR9iimZO5ZmFNa3kWX02bHIoAnySRQR3t4RtfnLwdpmOfTQQ86hCda4/WqT1eTCXh6w==","shasum":"7fc6ec20e388bf0c2d2854943e6022501d8edbb5","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.13b9cb7b0ded987d2540334b42c530f888514d74.0.tgz","fileCount":57,"unpackedSize":628699,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfo7hICRA9TVsSAnZWagAAedoP/i5k4GNeH3Ka8Zh3y+8I\nPyo9atq5h6rOTDMcRbBiyqiqNEmBatpvLbohyZu+1tpCSPy5TXWYA6fMWnLj\nINCx1bnoLoDAK5etcIah3RliG2J6FnQdfn/v5h8PY+hsS4D5Spv0T5rxbip6\nJRS0ew1cpTXc5yp+cqx2WEFCSi6kB+1mvmnoBof4hDF2jAX/bLvzRcCpNKEd\ntl9fM3hBde8kZHXqwDbCg8sDhVgu2CJ7J7ogsqONRtRdbcBf2+QHSEQwBD0g\niKO8KySYQ32EA0MhUJbId2T3QDOG4/WLnAVUU5Z68OZ+Lw7fYdXRRPnD94ib\nOqh6HgnKr3vKVaMdRZ8dQ5OsvZuxCijxibNAQ1rOw37iXwLudx3EyfG6VZy0\nXU8cQdfV2QzvL/OC/Z2dYwKHLPGLa5af3Z8abG4fl1Mj1D0dJz0uQwwWWIkX\nfjrm+gi+snEysotMxgyTyQlSCpGjsfem+vzDYkIaFFMdqyB1P0NKMYeTlgjg\nWlfLuIPZlLTUBrvDHkgXuCr1RlYb+3/55xjmYPKlfwX9QMYnt73qqxAlZ8r3\nCAq/lSMl4C8VoQcHse5v3BmaxUWkyQVArXe2b8g6IePk5+kkaoT/aPdap2Sd\nqtvu7qgIC9TDInbBaLFcTgXfTNHM2RAf2oZ9H7axQ6rEid2RICOcyLcTyfN9\nb15o\r\n=I8p7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCZmyFcwOnFIT3QKZVyie3xzFI5Skxv92+d3KI/JVblZAIgWl5rVQy4Ubu+iENNsuWFHYGsCQ+wDM5FNvcUd8TTwU8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.13b9cb7b0ded987d2540334b42c530f888514d74.0_1604565063459_0.9487187744128656"},"_hasShrinkwrap":false},"1.0.4":{"name":"@sberdevices/assistant-client","version":"1.0.4","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"529d39e87c99ad0c84b77cd544485ce19d86780a","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.4","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-nD5pnCVSeyIY/dMtpjiQ1nv0FeKlPJ5GcPhUqSuALwgnwijR1+U1HUlbsghe2AoBKl5HX7eSOzLPhTMKaKEVzA==","shasum":"b776e28b63597d500268d994b92cc1abc0796d52","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.4.tgz","fileCount":57,"unpackedSize":628446,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfo9RSCRA9TVsSAnZWagAAxp0P/38SsNATFpGMIzacc2In\nS2/L8sz90Bl7dyUMOBJf5i3T9MSMiD1aSJfIaflcUJF53NF/ojhMlJbgibQt\noNzfOA8z4ERx4tPzsha9tYdi324GQ3n1l5uv0t7wCeN8VKIA3jVmFWplgU0m\nxTED+/9+E2jkJsmY7a/EXMofjS+4dckreQJ3b7sEry489g0tGyqVCEd+6Ftq\nhZZ94KbsuOCvseFCFF+VYRrjvjYj66rSvofeC/ojNquSvjskVYXwMjRsAJvx\nsZSYXwo+F6PZpbeJPI7uSwh5IWrlb1KaRS9AQPxpfbQCubZwUtWgelfAHX7b\nwOre4NCsaSpn44QzycaLiGmc92cW4tsnDDMppTa+rxLRzFWGxDmpw9lnynqB\nYx4s1FY1UZtB0MsC3HAgQxTqX8USSw4R/wIkw4/5+FU0NU/KaooDSW0mRQZS\nBeD/VSJzOcVcoYZCIihIVGhHeKsMmC8wD00eIa/V26/6kwB5ft/zHOGfMnv4\n6qjoQxEvPr/WX/5PfDWxx0xPb8sWZIxSVGWqTUg27y/BxTMZdNuGjwXC6Cn4\n+YtxOciHJxFEFnNaqP3nm2fHKva4+uPHt1mLOjFxgfbEKDouMDRPQ3eUfJ/W\n046xvDEC5BbjRpLqfVHb8KDHmyCAqjARzm/K8aDv3yN+JH3ziGB60qSDf4BW\nvmgn\r\n=6Ua6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICbt79Eb9mdorLEtSo/ZePY1s9taiUDfIC25gQe01jZNAiAsYsJANgnRsN/EF+GHTWQZV87mKIO07BIzKo8ivCi0Yw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.4_1604572241929_0.4109506893098458"},"_hasShrinkwrap":false},"1.0.5":{"name":"@sberdevices/assistant-client","version":"1.0.5","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"a9d41590aa80600b2589022228c7f1de5aac70de","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.5","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-iKYCYqF338OpRKp3jOLZ7SGjJcvc+k2Wjyj/LjIQ4LIbEnMrwtigBb40NENWLTFEIcrlll3gWtcxlUhKYgTRbA==","shasum":"3630e3c5e1e8803a47c3327e35167ec949589ad5","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.5.tgz","fileCount":57,"unpackedSize":629108,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfqPUkCRA9TVsSAnZWagAAZjcP/jSUacsE0AOX8cOQu/++\nXbeydFUaQez6Ok+gf1tnvyXAm4M3L3yzHDdOKunw+vIhHdyst2hPHDL1HLZS\nHBEJPZ9f8U+jwJ/zbVT0T2v7u5DBHeBX2xmNuuNfZQ4f2Gg4hMwNtQi1Bn4I\n+URVlFERFkm8wHyv5nJAFxbiTIn6wX58n4Z36a0eVHgCKAjObL5HCnORPLnJ\nk36ke0LdG8OaAj83LQMu++kZnYMjufIQTUCV5Nc+96uqdtBil2e78vgIZVvy\n4pN5K1dPGAsKcRMFCV8gN4giFA6iiosEjW3XJjYJUhkpdsTr4liXOxMTb/Ek\nQG2jXf3L1a8/opYGEuL70q3bgkcPrjPB11RfpWDo9czwiRlDmwa0zxmyjaiL\nzMWZkr24U1W+4ueZbtOnwNnXxWr6DP6KSiGfXsjn0CdDhxEKTtEXm9DH0KvB\n8M+p7JqelLmWRJ1szNRFoLCkar2h8G62AISpqslqR8RsErqOnDN7K/Qm2Dqn\nS13WNwxPFMFFL6KuqMowqBPMY5a2zc3FHlcuAPbO3o2SLRH07xR8xOQj1ejt\nGCnbySsM1yBkfatdWuJ/mZCWP1A7D5aBrfo8EjM/BOFeCt3+PeYientk2DXO\nG24pH0bXPyKBAt1hajx2sPn4RoOnwIrhl7bboFleJsVohAMGcT8qdkQtgQlT\nOj+O\r\n=ZWaM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFqDK6EFpnAC9Shs4TjmGm3eR7fwqP7F5oVYUExF7Zl5AiAuE91CaD7U2dVN04YWJlmD3R/VqlrlK+s+tMVjf7Py4w=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.5_1604908323610_0.19846885708495132"},"_hasShrinkwrap":false},"1.0.6":{"name":"@sberdevices/assistant-client","version":"1.0.6","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"25a7fe2dddd9225aa0b4e027ddbe3f2db8794613","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.0.6","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"integrity":"sha512-2Z3Ulq27VM4tZAywCXMZXCV7fwnHRWES6O01u/+Ra1DqowvSZR8Iqlu0Mzbvpz9me9M3zJghFZ3oJuhs0ZLaiA==","shasum":"8a52b845ff222370ca155a5054df8b2be84e7fde","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.0.6.tgz","fileCount":57,"unpackedSize":629123,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfqsBtCRA9TVsSAnZWagAAoCoP/R+tftyANVtl5I0m+qL1\n3kWGmukXv4VMlkz6frAPJ0EV7rRpm1aE8KsbcdY9viI3jzUBXVmGzK08Lt5P\nOgAfkAVK+GIC85nOtl45m7iAXurZCeI98Xo1/5LktlbPDpF79+Of60t84VBa\nSGvRoCV4D9wLXjIYzxd7z83iIbBQrwqULLC/snxGk9DNhKk836F+9nvCdhdc\n7clhFLr1ShoHrDsxocabXaq6XQQPNvqU0HfCqlAluev9K3nbe5dNO/vBd7Fb\n4+bqeAQ7JqOD6WyfaZrXKbjhJNLGAWd9wwt4lrNLSwX0o03zbnSbp2omiYbi\ndD0ipiSDiKAfRIJBwzQiJmPJMr4wAqdW2AlE5AshpNYsW1zlTHqdh1CSjtL7\n6iPjyTuEhtIRQiC2UD3DMqceB39/wboQbNp1IX/KO4CJjksz+D13VwcjJTpR\nslzJyYw6iNhb0Vk8eNl9p2u49ldvCJs9cSAU/L/gikKiyh+jIwZstLdQ5Mld\niWPFqY6Nj7IuUXs1+Cgi1H2j2T7Ra0J2eicsg5ZlNWEOmSwDDL697n7gY85h\ngFHd13PczLiCyq/BklxhI4VrXjXXd3TI77JcJudHHIWe7QrTTsqPZvff4B+8\nGqJclisjAl4gtpWQ80BQhapOyzMhHrxJ3s1RLZ+VwUwQYiOF1Wj7yZkjxKWV\nTltf\r\n=aiUi\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDW8AT4MNKeuKhEueFvroG0c7K7tkvkSsriWZbg+bHtQQIhAIEsNPc8CFTrALg6V2bcsKY01vIGkEnz3o9iMQK0/3lA"}]},"_npmUser":{"name":"turanchoks","email":"ipuncho@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.0.6_1605025901282_0.4289743973412574"},"_hasShrinkwrap":false},"1.1.0-canary.28.8847c2c108c0d53c38ae84dbae2c2d3661879e36.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.8847c2c108c0d53c38ae84dbae2c2d3661879e36.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"8847c2c108c0d53c38ae84dbae2c2d3661879e36","readme":"\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер. \n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#Пример)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [getInitialData](#getInitialData) \n * [getRecoveryState](#getRecoveryState)\n * [Форматы объектов](#Форматы)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand) \n * [Требования](#Требования)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp). \n3. Получить токен в Кабинете разработчика и передать его в запросе. \n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token', \n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн', \n // Функция, которая возвращает текущее состояние приложения\n getState, \n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState, \n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState }); \n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа. \n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\" \n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд. \n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода; \n* голосовые сообщения через кнопку \"Салют\". \n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n\n### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов \n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя. \nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом \n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений. \n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды \n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.8847c2c108c0d53c38ae84dbae2c2d3661879e36.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-omeVZHXrWanEDPotv780gHhMVPtw6VehOu3DcjauqnASE5OP/ub8XxVkKwWQLS1Geskf099l6E1KvQV+9oVskg==","shasum":"e15e804c48e1cac7bb6631ae47fae8c35d500346","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.8847c2c108c0d53c38ae84dbae2c2d3661879e36.0.tgz","fileCount":57,"unpackedSize":629706,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfq8FeCRA9TVsSAnZWagAAg40P/1aVj+EZ8n0QZeIsnIQq\n+/VCcKQQ8fQDk5fRwrDMvOM4TqMIzYqUbyLyLK5VldZ+LU/m+6pFExC4vx2w\nVLwQhv0Pud3TIm60KYIY4p6DKthvi2XxRKQ9YwZAWfy6rKW0WDZd53xNdzbl\nXYmdF+/RU5gqObM6H1s8D3INQwUFjIGOL3qs6LIPO49k6KtS1hG4YdjZDWvC\nKSEpCv4wqYJFSTMFs/VzG/2LDKDR/J6BQc1pJ5jwKJtdD4WvlR+jWvRCbXYf\n2/OPzhAt0IKq+Z2Hz2EbFqXJyTqePoUl5pgmfSSkR6AIKObAZn6UKSoKRFaM\nkPR1itIBTWrJpTKKqDSTAKoLGn6mVMeNP0Z354e4uHHDGNtDZkP1jySWz75U\nRfe9US4DOgLKnLyx0jYj0ERVishH7+N+zk3icjLU4GDrTW4AwfiMa3RrA7s+\njTrYQCT1zhgp9YBFl3PUhmeJ+kZXgT1ZJozgPAd07qwFRZlByC9mCwzAr9zx\n3k1FAhPwGWi0GBAywAeItw0yKSsORlDj95omwNOpI6bXtB9uT3MjCpuglVDp\nvWHTSa6b4AYL1dEcQMv6BJmODN6BTiVzSTukjnCYJ0DmNaRCxgkN5bZDlt/w\nCr2wTR+vAm2iLg8PjzhxaRuExMzAUbGoEVyRyPZKtHMgODgexX9HQXcjw1S9\nbad5\r\n=duKx\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGHKgMUBW4vh3YUy0VKxHhVpW/fm2D2yjJFThBJZh8ZHAiEA236FqWYcWM597X/t+o2k5FInmWaoF/9B90Kddt00xss="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.8847c2c108c0d53c38ae84dbae2c2d3661879e36.0_1605091678131_0.11029185219585513"},"_hasShrinkwrap":false},"1.1.0-canary.28.fd9cb485eed455a9e6b47cd80b581d88d0b3b144.0":{"name":"@sberdevices/assistant-client","version":"1.1.0-canary.28.fd9cb485eed455a9e6b47cd80b581d88d0b3b144.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"fd9cb485eed455a9e6b47cd80b581d88d0b3b144","readme":"\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер. \n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#Пример)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [getInitialData](#getInitialData) \n * [getRecoveryState](#getRecoveryState)\n * [Форматы объектов](#Форматы)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand) \n * [Требования](#Требования)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp). \n3. Получить токен в Кабинете разработчика и передать его в запросе. \n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token', \n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн', \n // Функция, которая возвращает текущее состояние приложения\n getState, \n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState, \n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState }); \n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа. \n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\" \n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд. \n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#AssistantClient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода; \n* голосовые сообщения через кнопку \"Салют\". \n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n\n### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов \n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя. \nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом \n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений. \n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды \n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0-canary.28.fd9cb485eed455a9e6b47cd80b581d88d0b3b144.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-S5gfLqK+TgRYjA/oXwDPVzIEQVDs2hvZAc14uw/bJTEL8LVruCHozJKwByfDIwM+Udx0S3t/8VjCr5dGpWPk4w==","shasum":"6c5be66365c566c4349bb4a3a699c3438117c7d0","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0-canary.28.fd9cb485eed455a9e6b47cd80b581d88d0b3b144.0.tgz","fileCount":57,"unpackedSize":631202,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrN38CRA9TVsSAnZWagAANR8QAJNVnwJBBEbIgOGfNIZj\n/ISrv5EF/pYR/l88Zpu7Xk/rXGdlasl1PV/N9PxlWQsSQ5jL38WjwV/YLmJd\nhxNyk3TgiFgYpRDryZKdgqBB5CFV/MMLG5sTudJS1/2neFP8ZJ5wKNmXnnwN\nFlrPxQKXXziSH0cbu4VlmfLEUOdIz2IlNIsZZ/r6zJTcOoyU/VJzZO1ckABi\nnCxQg7mb+S3KqStSm2/1Pbc6Qu6tLly/6x2WGI4y6OkZ/5HygEsUfK6y3Vnf\nq85Xdi4bdWHK4g6amrYxaNqUSiNgj9Xtugtoo/W4CaGV2F2EmIj/ZKbmebX1\nhzbCFjOS9jLKQPk+lYOETZZmnzqvviRoHyxfVNPZDlKNGyeBmyydVfHjCtmz\nGMjKeMCulcHY6oAqkKcFtR4CI8b/YuJuT98BbISx+e+IxWWpLZs/gGcNf7RZ\nc5UbSqBtEWHMwfCmsksoxqcOrX81M1Q2bNQGV0bYVwWhwQgUBZpqUu18otr2\nveHmQi56zaY3sNJ8E4RUhLcGvCYwedYp/9XFt9smE0LT40/eLn0K4ivQdX4g\njEolW7GA/BrSkahtNe8lc06V6ckJudlYb9LTBDaMlQdufjo33GBaqeEz3A/G\nL7aHL5xyF1RTCq29zlargAxnArv9n+3qiFWEt1GpLkvR37u/2n9QsR3teEHo\n1Gok\r\n=lf7U\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA0+N9tRt6WuQN2eDCn+7cy/9uOIMqKi+jzRaBbaGVSoAiEAhgdzbjtQMe7DTL0ZSmhw4DoyU5VQlFNK+ERM8Zwg6qw="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0-canary.28.fd9cb485eed455a9e6b47cd80b581d88d0b3b144.0_1605164539556_0.13792855762229972"},"_hasShrinkwrap":false},"1.1.0":{"name":"@sberdevices/assistant-client","version":"1.1.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"590d7ac1e37dbc87621c2a62b29c0b2959ef0f78","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-KAIzenmQ9PDvCIcTO35nXgS4SkLC5uGgON6EfM/TKFUqlTF9qyOSAZe8FyjXgGl2BBVdOyUxFnGGV8kOYlglpA==","shasum":"20f32b8beafa925bd68553fa1d3bab802b37949a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.0.tgz","fileCount":57,"unpackedSize":631028,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrQbXCRA9TVsSAnZWagAAz+YP/jYyMoNvrurtV9wtkWMy\njkjPOSUgbbkd0QzxJmiAgHl16PFL4wSPa3EA1wJIc3gmwZjDfXtvfRl7dkwY\nHKbeO6eHmEux5h+wtNQXyBfgfjZo5nsPZr3cuC2V0dBVGO9wPnj/EFVXKYm7\nbu0DOJbNT1sVT07ulvzjYCO7JBzZg/tZg4IWkel7a/WEs9QEjeAfDAm9/867\nmtK3ScN/xIqNuA8kkgYhNQYyPTWPbc7lQx56WFQykPEplcS/NuwGT+1ScpnQ\nAteYXGXuXsJ/ihpa8HDWStvmmrn1Z5kk2+HDs2TalLy0RO+s35JFkHVE0orL\n+GEixgtUBQIYwZve+TfPHblnYiuvV0s9ejCUTXpy/e2csG6P+ECu6BBVtr3H\nh1vxy9q+74xZOF9f6PdmshRESc8lTt/17z6LswZ6T0ua+I8B/EATFD0QLJAQ\nQMQbS0nv/PuJdMPxuSd+ZGApsML8oEu+YlhqmtE8i9nE5y9vyn1kHUeVg2yU\nmXb5jCQwAX/WhATFB0hnT6wqN9Ag31SH5voqu1dVuYhq0ZGgP89o7s5A/TYI\n5QVpKdusbtolxZzCQEv3hkr8cqaJ/vA4BSuztH+NCDu41sVT+xhwWrien/vL\nFRiGbGrjgm91EC6zJRgO9k3dnPpWG+hQnZd6fQ79bR5AoZaTmpBWKu21VvMo\noJvc\r\n=gVaW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCT+JLaGVLLfS+D5NYVX4ykBJgOsbcewRONq7Dv3Zpl2AIhAMQpC8JW0ApTYaKsUuS3xoBeo1u2pkeX1pbrpl/ToBbQ"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.0_1605174998790_0.8016104148123258"},"_hasShrinkwrap":false},"1.1.1":{"name":"@sberdevices/assistant-client","version":"1.1.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"9f2b9dfc478a88e3ffba3d47ee0f6af33f2a1df9","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.1","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-CgRlJGmlzJCVI/XSIEi0kpbNhGbF64EGHdSoKf3FBlt3XJNKJHydvBfr05UFZocgIFEfNKlq3aht5PkekRc41g==","shasum":"eb1c18a7b0dd681f886f3b5947c68476b4642400","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.1.tgz","fileCount":57,"unpackedSize":631198,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrUfHCRA9TVsSAnZWagAAhScP/3W+HSz5ljRIynjYK77p\nVG2n45wKQCu/FDTyufooKMGwHrO2uWhlG46otqvfuTLp6gF89hQiMe7PE3OJ\nXvZBJaC8sbMYNVKZFNOHB8eEThHlIDIsIG1ObE93JIL+NKPHIq8r6UWPnXaf\nim0x/WO+8GSL4iCIyV+eM0QVXQ4OJVEeGQTVwSdywOtyomHduT/7LO0t4qQn\n5gNc1QdssPRc7ZMrMtOHbsqb2VUELJtD6uEHB9FM1ug1vcpqE8ZM6Rvv9xHe\n5yEwSDOCsx/leLaYoo492dT/0/hUU0zULMCW9zrQZDfp9zntnu/BTKgqYkDG\nxzuwnnP2dggB607mvL86vPeEYkxEk2IHYaUWh0AViOHSrV0tZnRCEFhbEV4A\nFpFaW6t3kqeB7GDv802IqBzsTIXWRz2Isk4rp0APDJRcLpTVDhLlT9boiSKD\no/5VTlvjTpTbo4lNEFHa0BWYVxi9xsLWD5Cx3mLYMOTTM8dG2ZAexlfOyubh\nUq95mngsNp0+IKQMWwJ2BFewiK670+ujB2T1xQOARvsyWQ1KLhOjEyZEAiQ4\nccTY3GbpaGqKdnzg7hwgPRRcVUnc6L/RRpvl0Oz03lvdnoAkHcaCq/ww4k7w\njExvADkK5YMATEWRjBDq3loKDOTVzRs6F4HJlVTLxkmNspOg8xcqoR5/TMOI\nkgry\r\n=oE1j\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDAbEj9pN84U9bhu9KIbhR/U0alWsmV+iAQC5d17UKzMAiEAreSxcdTeZWomgqWsZ909RJHiS/CVVLurcXMgLYbaUg8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.1_1605191622547_0.7574628568667632"},"_hasShrinkwrap":false},"1.1.2":{"name":"@sberdevices/assistant-client","version":"1.1.2","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"gitHead":"80307fa711f65242ec2f7996d3b758c47bf3b81b","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.2","_nodeVersion":"12.16.1","_npmVersion":"6.13.7","dist":{"integrity":"sha512-/fylnmfpZOJVsfwCgAYERRs2L5xKqdYBSQ7pu2X2d72c/Ad5sMbPvDiTZ60/+1DwrhMcizW176drYCC8mc9RNQ==","shasum":"d3b90833816d7fd1c5c823109bfc5c919a20345b","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.2.tgz","fileCount":57,"unpackedSize":631196,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrUwaCRA9TVsSAnZWagAAPXoP/i7UNC0B2GSyvDxWn5ca\nXJkBOs2QZbp+7XAJABxrAFyrxX0xplA3j0IkgRwlczT/kv8N8qtba7935LwC\nrV6t9r4G85XE1gixPUKu68nA6oNpsTba4p56RLMj73Jd1+AM7CNCMaHHcPdt\nZhbQlv102KsDRdy6C/kbBEUaqHTZBVaDAS1FlnUhsjx9L3CCTgGU/tflWUuN\nukGzpiO7FFL9xsn2fhncwV5mTjUgEXAxRBYLRcVwrF2Cmau4GcZ3QwrmjkUF\ncsSc7/2US6ha9KTiBUPoSyL9JOFF5x5yPMBglDGYFKxFErIdaFq49tNIBcLF\n0iP1+Ou2DRcA/m7PU6NBwBNmORewOvtsHRAjkl2nh6tD5+r562ouqnMzfYJ/\n9W5E568mVe+CymWSW7H26bMq/zJxb4Pi/bzxFBxcPpan3Edy6yIJCXPlcAAY\nnNmtHZJbO0oJv6tc48GgiYZbCVgfp0s4YVb8m/9g01H5kA+Xz0FA9ANv8Nj0\niu4KhtF8HobtfBIt6y6ml8OFkQtcJbAAjs+vSwJhFqkQUyoGDvcBesouSau8\nT9aMiZXqc1iDmys+Bzfze12OYakweVrEbgjG3wthOTjZWQUPukFudFkSO9xJ\nAYaoEHMh7BOqgzStR1pT33ZUjqu8nixH4cJJbXLawa6x9U9NZud7uOnSchPx\ntOmv\r\n=TLl8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGHeTIZ8MaLTWDzel/3i/vDENIiIOdoLlWeSBny+OKnyAiA8mQ9FagNx4JF25kDYMG70flH1M6HOgXLQh/Uf84O29g=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.2_1605192730246_0.9450865990196797"},"_hasShrinkwrap":false},"1.2.0-canary.28.37f04d67478d37b5a6faf8381a0082f32783ae95.0":{"name":"@sberdevices/assistant-client","version":"1.2.0-canary.28.37f04d67478d37b5a6faf8381a0082f32783ae95.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits"]},"gitHead":"37f04d67478d37b5a6faf8381a0082f32783ae95","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.2.0-canary.28.37f04d67478d37b5a6faf8381a0082f32783ae95.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-jnLBQsFNUS95cZCmFz514MWdfTlt+aDNKUhSjErWtDphJT7OOVbHcCNvxXYrhwEw639WP/pvphxHyfwPG56Qcg==","shasum":"3bebf6f234995c7004390a649f9058b5a28f6ab7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.2.0-canary.28.37f04d67478d37b5a6faf8381a0082f32783ae95.0.tgz","fileCount":57,"unpackedSize":631964,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrmY3CRA9TVsSAnZWagAApBgQAJQs9rGFUVA15dN8vo4I\nhg0U17HGwVpbmEg4JA508tk1uiwiBdcak6xB2Ev0wX6qzLXq63oRgMPHTDzQ\nokc5yqrPGPR5WK37ZIy7AJdxTHbZDUpq8NCL54NuRP6HU9/yKlVeydPVEZlm\n3mQAUX2Bw2biBw6w4R2R8kuWwBZYOkQuqKUn+sKAc4xnNqG+KsthrtsOJCkK\nXBxV9g3RKYGIc5LJStAqsGMGHciBFWfhESNClAid+b6VAvft7n3PM7yThpbK\nfG1yElGTiG0GiGKoxliK+2Kb7yY4wAvSigAPyHC5se0y4LdU+CfBomSpcLdv\ndUz/HMstEcaPUWtpcIuZfTQd93radEi+WeS0afmTdI49kO6z8E8lX3VfXYor\noQ5RyHJujc8ppl/GSWBi1mgdaGEXMl6p+Y+Ii9Rv/B23E4CodQQ4wOBONP/r\n4qfF2JIODJa4+hS+JSQeGVON6WtO8EVagnjbWWxnLfjDvAY7OmmlZ+Nk5cEu\nx61k304omSvUlEBhCdUqJMkFSeLr6OWyrdr8+OzgEuBgvvubXBfSZlQ/YsEL\nid/9lHME6XH3JS5cZO6UeBzsEDa1SiSQ61vKvDdNerVotYChfTxNAIk6YNBf\n+bMfSxURKuc6zSNAoWth3vMfuoGV2VQDeZWRj86BhWl6ULNLCS5cnhzsVh8y\nrNlS\r\n=LIWp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFK5dOAW5KBnxaSY3oB704agsPwiRyGk6TmAe97DKEE/AiBiK1dy8+vdKV4B6J9FpFuR6Xl7wTcEmCuSGW3nrJ0T4g=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.2.0-canary.28.37f04d67478d37b5a6faf8381a0082f32783ae95.0_1605264950827_0.5516009248121405"},"_hasShrinkwrap":false},"1.2.0-canary.46.35f944b7f71f70699a407c0fc41749c063fb49a0.0":{"name":"@sberdevices/assistant-client","version":"1.2.0-canary.46.35f944b7f71f70699a407c0fc41749c063fb49a0.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"35f944b7f71f70699a407c0fc41749c063fb49a0","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.2.0-canary.46.35f944b7f71f70699a407c0fc41749c063fb49a0.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Yt9CO/taEZUsMPXqS+y4Dk3Bi+eSfIrP2OBh55VbLayW+pVANVloPHJ9ypAPxQrq8oqNFtUGd9q4sgcBJKK68A==","shasum":"27c83d9238c1dfa5ab467e10b582d5c81572024f","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.2.0-canary.46.35f944b7f71f70699a407c0fc41749c063fb49a0.0.tgz","fileCount":57,"unpackedSize":632022,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrq4jCRA9TVsSAnZWagAAMX4P/3lNSPwmJDzSHyVOyQPV\n/5u9KrtQCIWjr9FLxhE2MWitiNbDUcclzCKtTvc2VIguw7ZpAowmtc8emBDz\nQC0aXiGuI4kO9ORqQkIBiyJQV1/r3s4+06+hs/j4FtZFH3w1K2sbJEPQBfjS\nSrsX4Y/4KZlb+X/tiXxshbQqhZ2EbV4gpODs7XfwPGYjDQq7tDGnfpGh/txf\n7dsZ41bChPgwUXOf2qPOYbteiX4z+XplQYKNkftmtRxj59rODhiM0if8CcMp\ndfL/NBbBZkZUR24uFwWPBtwEsWNXwzWBd4qmKm04imSukSmk25G1w6jLG5vN\nQ3JjNbWaXRA3sQb/Ii7dY4zSXWbF+Ox3J2+gIo4uRxhSLuRsXgUL55gO24Sg\naoPORXRJj1fVcCG680jTKhKw5nwI9UHF5wnqywXa+HFV/M0dQ9/9GXZgeH/p\nbYcpNY98EYr9AVV/M2zFkYqyRHoxRkCNTHVF8OywCl8GnjeacgqBX5TMoSBa\n8CvsAJ1RjAzp7AZmB06Y1Rh5Nssr51w9Bl7mGf60CM5EPBK3OOEO3rige359\noxuyPWGpRi7OLqooFBAQQg89piFbU2KCCSO/zQD/ltMPTJoYkvlEQLHBMb/X\nY1EsOk6/X1+ALwj5jfFaMozAL22G9MXhjG63FuDyX6GO4kAJqwtvzg5aH7QN\nZfOL\r\n=gVfL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGiJlu5kw7caM4IL8/d0aXzwdaUPjvaBMvgODcZfnUIJAiBWSgOM68lLMAUO28zfgkrBNo4nB5qjQpttjVANjxDOsA=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.2.0-canary.46.35f944b7f71f70699a407c0fc41749c063fb49a0.0_1605283362935_0.6689761399300478"},"_hasShrinkwrap":false},"1.1.3-canary.47.c977db33a85d8c0059086e42bf97ffda2a8c0d80.0":{"name":"@sberdevices/assistant-client","version":"1.1.3-canary.47.c977db33a85d8c0059086e42bf97ffda2a8c0d80.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c977db33a85d8c0059086e42bf97ffda2a8c0d80","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.3-canary.47.c977db33a85d8c0059086e42bf97ffda2a8c0d80.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-d4D+sjYkM9yXjoVHyA3X1Nac5mep5xzhlG2Jyao4KXc528swvJu3YHMebyavsO7H/kFsdXXH0/PN2BvW2kQiGQ==","shasum":"efa3499a521c673a493ced2873f7976a390ebaaa","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.3-canary.47.c977db33a85d8c0059086e42bf97ffda2a8c0d80.0.tgz","fileCount":60,"unpackedSize":634621,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfsjMkCRA9TVsSAnZWagAAktkQAIjFcFS+QxKNjzOJAwBZ\nNKCw9VuwxhzPCbyjnhe+qEFfUkkkLWv764V0jnPJQOpl3Q9Om2iY2yj4OaOF\nYRyR4VusKNSYYfZNFB0Snc8/9aCAlMo0ySH4mgj2mnYDk6Gs27x1V6lcpEQE\n8se60msdvDn7BO/Qb3bCVLHD03mPCLIcVIzox3+9cpiVqIH0mXA8RGWHusKn\nqOC7Fs7M6Ge+JwvrO26OSlatXuoVYMFcSrPqoozjT49Nl/k9nIzpKxv90zDx\nd/I7k4RpPBklw/BVcJ+Bz4diMvr293jkMn8HnbI63W/1mx/zWLSIVt99tMR2\nQPjKJfeUUC6rEbRWPE3Ppi/SHTnXJRfto8MvS/Izl/pVQXdIpcJ3Eu77mr/M\nsM/qrRb+sl8fH2kruHAV62Q3+sBPa+J6UaG6neWfIU4IURzLKQ1uKIrY5WsE\nTBtg1juADVN3en8T6F3krMGWic00Hy2crEZRNQ5AdGPmXZ1kegrk2kix90Bt\nBgz+5rLs3rgGq++WO89F5lCBQmaLhfA1N9jevKFg3AQDXYB/ZwqvMpNaRzsL\neGtD/nfKGU2yCA7XgwLZ/KooB2hUPgyzG5JflZ/D3llK3fNmhuhmhEQQjQOs\nOLSUJWCsp5+8xW6zXtDgY7xu7mxgNBeNBAC9xRX5PcPsRqvlN2ymsw9tAsZa\nkJw2\r\n=vtH8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEMCH37VuElPivG+ldtPUHbTTq6AtepeUfy61eTc85aKk7sCIHnigab4xQcpVoj9YyKtVNC+lU+zer75/xUAzCgn6PT1"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.3-canary.47.c977db33a85d8c0059086e42bf97ffda2a8c0d80.0_1605514020226_0.03153994373231095"},"_hasShrinkwrap":false},"2.0.0-canary.47.36b72a0145633e6dd0859a486cb4afe4c660d3d2.0":{"name":"@sberdevices/assistant-client","version":"2.0.0-canary.47.36b72a0145633e6dd0859a486cb4afe4c660d3d2.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"36b72a0145633e6dd0859a486cb4afe4c660d3d2","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.0-canary.47.36b72a0145633e6dd0859a486cb4afe4c660d3d2.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-ldG+DBuzg4FKaZehUUgEey+SXvx1jkEo0aj+YW4fucVswO+igDZGWCJkQ2mmMnHj4BcZfWIhllcWvD/TkpEbaA==","shasum":"7896824e1453d1e60f622a2ad1c53e60c61f006d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.0-canary.47.36b72a0145633e6dd0859a486cb4afe4c660d3d2.0.tgz","fileCount":60,"unpackedSize":634621,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfsjU/CRA9TVsSAnZWagAAURMP+gK9FkOXBfh6qcur0UVp\nAqz/8wfu/tuNjRcqsdD+KOaovIReJzy628rdijlOJ0jUeOi1CZQn3DblZVjp\neiDiPtXRcJBoyZhci1A8pKqJ3GXMeiK18O0dUncQ2Jicl1ysPDbixn3svnYb\nIM/yLg3P/NvFnEUCQetvBa4NtVDW9BdFE+Ab71XmKwQwPX+bBdUa6xgZRWdZ\nTR6EUFEYrUs+0IF9Gd1nZjrGWyrBKBunngHSKuwiVmbFX6N38G5A8+Byk7oI\nbr0SdxtKaTGEbj8hjzY0ccURft2zp7b9dntqt3NxYnVzKDPSlmBlG8y4oavn\n286D/yKbL7GCdCXjHeNTetvYATFe3cTePXkqjZGEUsy1gWCEcqgsBZzXsCH7\nBsbCrtfBt1mHF20P1PyL/mISlMmppPdDSWc9AlpIrLAnareDA36pnxUhaZaJ\n3AYEg62Ta/TSM5S8Mhl2cKYZtBZH5q0yjvXJ6FizY++vIpz0Ih3I8brTrGJQ\nNNg0xVcHhWxqFNNXUWmpG4OHK+tJ5Ykriz1pppX1BOQejHXsmWNOu7fZNt/S\nm5j3SFUJfPZnIowh3UnJWEOLQB9u5eG/xc8g/sg4L329c1xwk1KIpJZXDHOi\n70Kxd6CLQWZfhve9PVryzw2hBjaTl5uHvglhKAw0El0O4QDrhFBtCaPpu1P/\nFQAL\r\n=b3vG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDzLbHK9rvoay3oUOzwKSutJxfht6/ITJVqwRAeePvNkAIhAKHz/lyr8m0R88JAO5jTDGskq+RF4lKjGjprDDLWGJKu"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.0-canary.47.36b72a0145633e6dd0859a486cb4afe4c660d3d2.0_1605514558461_0.35537428737397225"},"_hasShrinkwrap":false},"1.2.0-canary.48.5300a8567f6a164f0926452edd09df73907cf1a5.0":{"name":"@sberdevices/assistant-client","version":"1.2.0-canary.48.5300a8567f6a164f0926452edd09df73907cf1a5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"lib/index.js","unpkg":"dist/assistant.min.js","jsnext:main":"dist/assistant.esm.js","scripts":{"build":"rollup -c && tsc -m ES2015 --outDir lib","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"5300a8567f6a164f0926452edd09df73907cf1a5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.2.0-canary.48.5300a8567f6a164f0926452edd09df73907cf1a5.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-ynUOPxr3qCPKDpDfuRevqMRJFYMSyz376f4Pkr5+gjsE73mSZ+7mo81xOz+AkJ2ifWjFKFzj2b3NgN2p/U8ORQ==","shasum":"8b4d712d2fe3ab9d560534625c7e51c251e69d68","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.2.0-canary.48.5300a8567f6a164f0926452edd09df73907cf1a5.0.tgz","fileCount":3,"unpackedSize":82186,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfs5NRCRA9TVsSAnZWagAA3aIP/ixYWSo3+urtdeODa4wV\n2FoojUpI4yy4qOz2blmK2KxyO1mOyvutvOGoC3669751+tUA+QdfaOYBy/zW\ngzm37ExcRsSZQm9F2o4Uf0wJpj0xMOAh+rMM/QqjmxLX2GQvYmNu0z68QdVm\n84yCiWvSOt2osW1evHiQy1Kebfc/6yfY6XR3/VvI2z9Z37zIQOaAoxAUKXaK\nrDfRIQENQKO3hnL0YMfDTORoagBqY4QdLwHlm/Z/dyc5ictfOCfKhZaDHd3p\nKUcvBG+3Dbe11cdeEvk0vSQtEmkDlNAusEacxK8J5HoR4fUfs2ZXMpVmQRjr\nDG5zhAqo+TjQk973hu8rMq3HhisAqNYOHCB8yKjUGMwgt84cz4aaPYgq1l5c\nfL6rO9YdfqQHI7OvVyp33xGxjO6/pg4UMvyzOYJeCq3ntcR5cGYfnUgZsGrr\n1sN11cW0ZlnjXi1iV4Gq2gjGbhN5HsWb13j/mEj3DR0Kyc5uBg5ReF6gQqVh\nlnzeEtaH/1MgBU7uaZJUIeI743YL3GnnkdP4iYtMdyBEOQwnjEhNf915eVNl\nxZyHGb4gh6XIfM7lxVQWhOiR3OSPhCIIjgegc+1m/BdnvmOU4cZqZAmDZKc1\nVIOF+xQfJMJDyHFXvwXS/bwsZ+74taFIiJmsy6UDz1L98Ahs0B9ZPWeKp/hP\nC4bG\r\n=+mmc\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA0Myl3lKfYy/mHEDIOktKI3nq5V1yi5UoizWqVTGDfoAiEA7TeMy/3lP8+2loUS0xwtlieKpT/DajOMTvP1VkTHHoc="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.2.0-canary.48.5300a8567f6a164f0926452edd09df73907cf1a5.0_1605604176943_0.518413457662408"},"_hasShrinkwrap":false},"1.2.0-canary.48.06759b70740bfa05ae3b420701b5959a5bfb7b69.0":{"name":"@sberdevices/assistant-client","version":"1.2.0-canary.48.06759b70740bfa05ae3b420701b5959a5bfb7b69.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"lib/index.js","unpkg":"dist/assistant.min.js","jsnext:main":"dist/assistant.esm.js","scripts":{"build":"rollup -c && tsc -m ES2015 --outDir lib","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"06759b70740bfa05ae3b420701b5959a5bfb7b69","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.2.0-canary.48.06759b70740bfa05ae3b420701b5959a5bfb7b69.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-zEjniqEbQsuUXXsRlnUC9R3oxeJU5nzoZYqqu98jLayTg6qFDGXxVQT6ERQx5UkDAkJjIZ00RX3QySyzONtE6Q==","shasum":"240ae27178fe337413c33a993eec364349558abc","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.2.0-canary.48.06759b70740bfa05ae3b420701b5959a5bfb7b69.0.tgz","fileCount":56,"unpackedSize":1508171,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfs5acCRA9TVsSAnZWagAA/ZgP/2EDuxSWG+XeFDKAZ2Rs\n7gIfm7m6yBm7sIrH81YmXqrosf/F91qlAe45rqMgmwRgaIEZTwO6Mkqi1DqU\nKtF8O6K7wJJNgkpq3+n05I1KQ4hTuAyJlK9UrFp6dZU1IRP4oSj0t2lJvx1n\nDO6NXNFrkTbAU0Frl6Ct49mF2nhPbwbbKdxOKJIAT89+2XSlZU1G7x6qjud4\ng6XNiFOwnAMlErx2+Q9jfUQzHOIbJtR+SPRFPg0NPqnhzBeUzCmNWeeGveH2\nYbGdQmAV8LRKp+zif78xMaDqNNK+I3yY6rYO4F37ObgcTjBcgu1TdZNk60r6\npfDrrNyJAVgvUSC8zzVijt7dbMQuq8kk2i1Te6bphP74TYs25mBpMeWTESUC\nKGjPS7ePL9jm4ekDVLhI3/90Epnl+BF7m9wKNn67RzUqqmTrBEFRWILAxGMw\n/V9OftcQgC+icKu9sJwSQzu4iBMJzPZ5gGLa3WxQJ5R4C3ssmagiGqt+YUmP\nQvO5cKGG5AmaT1CAqhlGL2dlH/Uyd5o+6aHkKIm632z2oGdbbvfATPSddr9Z\nV4DfHWEl/IlTPg3H95T7Zn2EMINQv6h7qkgITe1amSEx6wWuzuq6hagHnDwa\n84NK1m/KlT8vJvusV+6qh3MDh+ulinmm25y5v3k1/rmmVO8xOQdQlV2tlsHw\nMEv7\r\n=r+LR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDWdn4SWDDO2NuZ6JMU0iXpe0HECfzrxzIyR7b8NT+8DQIhALTUppVe+5mTrnI5GeEqhX2ciBKLNIcdONh6o6Lfsjmt"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.2.0-canary.48.06759b70740bfa05ae3b420701b5959a5bfb7b69.0_1605605019612_0.9423354671751081"},"_hasShrinkwrap":false},"1.2.0-canary.48.2d58b78418ce0d9f4ec58383bb4a9eabebfe402e.0":{"name":"@sberdevices/assistant-client","version":"1.2.0-canary.48.2d58b78418ce0d9f4ec58383bb4a9eabebfe402e.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"lib/index.js","unpkg":"dist/assistant.min.js","jsnext:main":"dist/assistant.esm.js","scripts":{"build":"rm -rf lib tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir lib","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"2d58b78418ce0d9f4ec58383bb4a9eabebfe402e","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.2.0-canary.48.2d58b78418ce0d9f4ec58383bb4a9eabebfe402e.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-RrbpfMTugFYoqVuSKoe6I0hhnV5va/K/df+RND4miPOamSY8FgTdfPlj/cFCKTYwE907FF9MME9wnI76a2hQJw==","shasum":"d8d999279181f0af6b493b3d3e12fb23d7a52ec7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.2.0-canary.48.2d58b78418ce0d9f4ec58383bb4a9eabebfe402e.0.tgz","fileCount":56,"unpackedSize":1508205,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftMdwCRA9TVsSAnZWagAAZzIQAKCW5wizDiC1PlPOcSMO\n5MnHmQTDpR5nxCU4dYiFfPlFqBAnZeuVblebovU0WvKNxAUBiDsVwhNHyGv/\n64yH2c/rkSo0FiYZ+lXTTviyhEd03QlUeExl1ZqhF0j7gAKBmPtOpRKVOTbd\nHR5fg/8AVMerA9NQBGXvjbUeB32yTYb+WwV8SZVJh3vVt3D9uudx4I6EF2Ul\nDUmZVAkDhBGk4svXedDiSC7lXSE9dxSeriROvEREK9T6+iOe9JKVm7dBhTOt\n/qH72itSlSTFC2SwhhdLTira5dY2wo6Mgr++C+1xZRdTucQ45ZJap74dYCzv\nmZR5LNxb8o8m6qI4vc7CIBDzPAw4OFmrdL0yS5UKxvNrH23drqMBN29KbZyt\nVoDzKQo/qVahyR2oSE8UCrrAKQs5OgL4UjfQAXerh9SuLR9XzRmIwHHP5Rrf\nxadWZJTi3edePv6XCVJpCQEUL8B4CyI3CGIbGb490bH9vYSMBkZCoav961wJ\nCTUs3arlMrGUPfnlDB8jeMsTuNZbI3Mk8P0IwnVc0c+uFKVS59e/275oFwN+\nWUvFHat5heE/LbIj2css7+VfuNNYV4ILtrw93nl5AsJ67gojNoPlxErt6ALV\nFp1tLV6Y9gUB6lAk1u6y5GcIfNMuKtr4FK13n4aORewOcgtrx40nlMLcN0k4\nAGBD\r\n=XIdb\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD/COFesOEZlTMortc5MaSZX/woxx4L5kbGu4QNRMe4TQIhALLzeKnHCzDI9G/83E2joSX5GrZ99SZ/UkIuQv0Uwnqq"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.2.0-canary.48.2d58b78418ce0d9f4ec58383bb4a9eabebfe402e.0_1605683055416_0.33529382908097305"},"_hasShrinkwrap":false},"2.0.0-canary.47.3f63e50bbf0cc6e0a4a744e6037012680fe05216.0":{"name":"@sberdevices/assistant-client","version":"2.0.0-canary.47.3f63e50bbf0cc6e0a4a744e6037012680fe05216.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"3f63e50bbf0cc6e0a4a744e6037012680fe05216","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.0-canary.47.3f63e50bbf0cc6e0a4a744e6037012680fe05216.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-qFHEx6R6gjyP/Xmp/NKMqUqU4UJ0OgazM3kBMijk+X9uZx3kQI7r8elPhv4GCvkQQT8uJVasI2jLuv44z/Tp9Q==","shasum":"ba2bf6144151b5226b04fca221450c8935d44efd","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.0-canary.47.3f63e50bbf0cc6e0a4a744e6037012680fe05216.0.tgz","fileCount":60,"unpackedSize":638497,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftkfeCRA9TVsSAnZWagAAapgP/i5wMGO8uXNehRWr9FW7\nKt4gMCQS42xwxx10F5F5Ud06D+XQcenDQ+782jSJ0p8sTbFnP1jE6PO8bZ59\nPByJceHWVN+NkLjjynF7LJVYgouxDhcqhqO/OyfYp5DwP4hxH/iKh0GWGkAt\nKN5mbNOSyX3fMhAEkHEFyDqOYpRKZtGA2ketmEu8HDuuxDUAFlRCtWATsDD1\nTiCGV8rVQ73LBzZ9klsS32PnkfCtj5BIKIEPGk/jfSgfOpOm3cRHMEUgvaNp\nJXF6SdFP4Nmvt+fF4zssEOt8iCcRHyVyOMNSITcFNv5rDJMOZZwDdNA4VWwd\nU9F25fh0KXL95yFTWr/JPxdF1Grz3YHyH6/kNeyPkyNSELRn7aqmMtEuCAL+\n1bFW1jvnlQA6YUKiimiDPghIFf6aDePtLZmMIOl85gIYbAOvqoxKP6mH17ro\nJNT6Q05Hcb7SOLMHtOi13Vx7vY+gT2wd0DlXJ1Ohf2OoCjyOntPz2jUdiHnf\nEK7zx46vnY/8+trlBysavPLNFphMq6AikW+aQtYrGjgtAouaSwLoxg5Byvok\nbYmSS9+NrCbRoYAP1TVSpe+wetbw8qkdkiNVGw6VFsZ80gjr/CHsmMfWnkuK\nGgBVsbwviLxdzNo9hHerb5xUQyCRshVgeq5hR3uBtn8y1jc9QzIr2phM/b8p\nCUiG\r\n=p4r6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA6RcEqbUYplO6046vdLEda3warCXmZL2joG90Mr1cr/AiEA8RNftx4kb7lEkHGVdMpnU7kms1VjaFVAJnLfLGBhKP8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.0-canary.47.3f63e50bbf0cc6e0a4a744e6037012680fe05216.0_1605781469827_0.43107888487510926"},"_hasShrinkwrap":false},"1.1.3-canary.51.eb7663ab912681c9921b58b8434133cbe9f8cfb6.0":{"name":"@sberdevices/assistant-client","version":"1.1.3-canary.51.eb7663ab912681c9921b58b8434133cbe9f8cfb6.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"eb7663ab912681c9921b58b8434133cbe9f8cfb6","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`. \n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.3-canary.51.eb7663ab912681c9921b58b8434133cbe9f8cfb6.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-+LE/712UOmniIQfRG849jaSlsxTToRqAor+3xTJgmlkRugACIGWxJAhjenQXWGPeJxt076K2E5oSi+KpEqyZSg==","shasum":"6d4c5648a036690e7bff5112bffbbce85f4f7a18","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.3-canary.51.eb7663ab912681c9921b58b8434133cbe9f8cfb6.0.tgz","fileCount":57,"unpackedSize":632522,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftlgDCRA9TVsSAnZWagAAYWwQAKIwWFdFMqXtd1topfrA\nc7/Opnv+TcE3IZtLRtrEXUSliE2BUJxnThH7YiFQcBvL+vC+9keUPaWhJ3nC\nGRd/AijoVpFDJeLNueCGKc8KUmy5aHJyVBi1uNm94coJrt6Vh9wreyCvpe8J\n3myDZSexU29A0Pj6JPYcoE9KEZv90jntsuRNrbBtGOEc+p6KHQMMnIkC9SiJ\nBQOvRW4ZxdpxUuBXILAlBztJ3WTyNy+4rwFMhTFUMJ6Rtg/HJ5B2SqxVms6R\nc3sZXzPVuk1ruzdIafUMccuWFUi70ayoSjRIxUkbm73cAsgGRRatsor0dw0d\nrZbNMclrYJm5jt0GT47nSnR4vl3l5HRkF9cZXEXsjf3FHBZK5XaIuensbRrB\nUZvhhEdE8PjSKp3ui031aedE3Dr+F8LR3wttMwmiygoNQzvp2OHpYjxLIu8g\nhXsPGzp7P8ukQ1+iWZogKMUXEO9DP6R5fEbheC7l5ikWF1iJE6zVMa6YsFHs\nKrcVPmETK6n4jkhUjLSWUyuUFzium9mWKcRZAdDUhZME5kdxdC8P9PSJ+Ptq\nlApf7he6XnuPDr2NO1yFRuDfxDHh6vIh1E7ylTYiF5NQo98drOVccqAK8D5w\npLbq4756Ph4IQM6gEsbzoj7THPtXtle1rWpSFxt+Kos/ZBE6wlCn74E9U/R9\nNMrb\r\n=PTUw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC/G1VR3AmHpeNk+5/1KwSTczmmjgKpsARmZ8JplbnDSAiEAt/GOlmjYiB/NKdkAtnWzCT0T56NUnquKgFIkMIjSKYc="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.3-canary.51.eb7663ab912681c9921b58b8434133cbe9f8cfb6.0_1605785602923_0.5918383651776022"},"_hasShrinkwrap":false},"2.0.0-canary.47.23999220acd326b1b94bb988a8dcd653ea564075.0":{"name":"@sberdevices/assistant-client","version":"2.0.0-canary.47.23999220acd326b1b94bb988a8dcd653ea564075.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"23999220acd326b1b94bb988a8dcd653ea564075","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.0-canary.47.23999220acd326b1b94bb988a8dcd653ea564075.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-az8kn02iJ8zp8F7RFeaLdpEt2GZxiOVGR6rpI65PfwJ4BskB4ScTb5GHPN9qp3dj0KQqc80DTiFxlOk7+1sgww==","shasum":"cb192458e584d612f7d4a9da16bfef1600124532","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.0-canary.47.23999220acd326b1b94bb988a8dcd653ea564075.0.tgz","fileCount":60,"unpackedSize":638852,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftmSDCRA9TVsSAnZWagAAeUoP/3fVdxOEzO0VqCu2lt68\nc8jgF6QV/YRE+9s12+TnUcpq8taip3szRPg75fYm+gPVBXQ62XZgA89T2gSN\neuLISPQ/GYEaspkXUNBUKpI47+Nf70XHFlhCiy4EugwXVy1F3SPlKoYI7wlL\nOj1grVpnChPIuOcNu13QabfeJzqvHI+gDCn1l2AIGr1BOle1LmnmibgQs3qU\n1tb+RQYUJXLRAWIG/yZeu8NhWjXMiZhFPiu5L58JhpZwtWJgj1aIBWOfjDHc\nVCyTVGvgZlcY6kqAssYSoMR23Uui1C+T6P/WUs5k2jmMzzI6nqlJzJivrh00\nmjEGWQW0Xll0tvvC8YmNGnYkbcxgHdVAMqd4vUBy8Za1IbyNGh1blGSrOVNe\nt9MTzpcJTUBkicyFp8Uma6sjcKiaHsDQyt1sXlUY28SEXtb7N9kDm3kZkm+C\nBEyQ9T4RGMVr19h3fbB+roKJS7E4Xp/RQ+5AY5JhdC7SG44AtVitLUojiLf5\nj9f+yozI6yrVulUGpqR4ius5yJHwESdA06AgJOVQ3Wf2Y5uIIInsi5EMj1ce\nhmYGrtwihcJ9xBQb/L0jd8HUxYbVH0zD+blZvw8Exo+RWEVcdOpxRBYJlkj6\nezSUISngmzntPjiDAyWAzHPyptDtk6kReAPH6Qa9zbgUJSMaGFWAkMh677Bf\nbwiQ\r\n=n3zw\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGBQUvKIq+EL9alTF+mscc1kPUkBGSpbzQXElw7aHrheAiEAt8CFgC03GUUSR+GPKjpSsctY/ip0Cz4a1j2mT4bjOAk="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.0-canary.47.23999220acd326b1b94bb988a8dcd653ea564075.0_1605788802585_0.9430360049489022"},"_hasShrinkwrap":false},"1.1.3-canary.51.b066573.0":{"name":"@sberdevices/assistant-client","version":"1.1.3-canary.51.b066573.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","gitHead":"b0665737cb5692ffc3731113741cef9d6949991e","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.3-canary.51.b066573.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-9IUuCOWSzeFCijTJjicW6su5YH0qBtyyzNd1Ey3iwyZQhXNTrC+TzLLEmN9l4bW9BAsSvbJc8DB6UXdwem1auA==","shasum":"734e1ce3c31a355017e3442033a5403733aabd07","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.3-canary.51.b066573.0.tgz","fileCount":57,"unpackedSize":632802,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftnOFCRA9TVsSAnZWagAA9dEP/0Y6sMVJdS2llzcbeZxv\nG8TeS0JGtuZQl9Q/GZauJVdqJgAghH/vbP/lmcrDlN3+SBjqI6rFYRPNy8oi\nO5vXDoKxz5jTYvbjn4kjH6Hmn4NrpB9ETdBhiefviSWkZzMBV+mMN1KkBN0u\nr5TYuA5qeM3NAQD/gb/PTnTlgs+WA9/KG4NqrsA40r4b6GjwBH620ZhHw+q+\nEtNmXmCPdZ/1ct15S/vYm/82G6Z1JOH/suzU0mcnNlZuF8mq/0NtwWDBM3BM\n7bhdVzH0cCFtgi0qCHK5Z2V4E3vfOlpNIxwUINhSaDpQHaGUfn43uSvbjaBd\nb7Sm7LJhrG20l4BBO6HBzVUvOEOif1uc5uX91e5Y6pszIgaKEKJNOaRJcA2S\n5onTMIaSrd+UFrn09W4k8Wrhk3J/mch75uOFWbJ3oGXgE7ngrZZtVim8N2TM\nVp9DYIPOrqDt7CYIg/GtgBPTDGh8XJlg/FNjVJfmrTDP7qAg2KcWGiwvjuf7\nir03/vJytqxkbYjexDohrQh2l/6TYfJiP59qaqTk8vLYRYi0XvjPV7NAjxTj\nKzNHAa5ZeZ/dus+C3Cov1CoL2yLMDNijl98VZHV6AjhMiGHRQYeFVbTDX2Vv\nyyscMdkFg4Msp7TuHyJ/hhZMLGKUtjc2pPtErKgRkVqki5NT2P4r0MPo0j/I\nX0fm\r\n=DXV7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDCGxxAEasvYcljo2NU/xA39A4jcBGkNktgIj82mt76DgIhAIiTnjVox5KH642SGtMWdUM4vhV3DltJBZv5scQbV3EK"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.3-canary.51.b066573.0_1605792644946_0.5129660712868653"},"_hasShrinkwrap":false},"1.1.3-canary.51.b066573.1":{"name":"@sberdevices/assistant-client","version":"1.1.3-canary.51.b066573.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","gitHead":"b0665737cb5692ffc3731113741cef9d6949991e","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.3-canary.51.b066573.1","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-irP9ypfwFE4ykQBqOUzk+x3fQuEgvwKrbK5Jo+UdKWNBXr53P+1l/v9FpfYdl0aesR/9rORzyf41L9k1pj57GA==","shasum":"c51fc178b3daac3c48aa15ba9c45db2fe01b580b","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.3-canary.51.b066573.1.tgz","fileCount":57,"unpackedSize":632802,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftntlCRA9TVsSAnZWagAAUw4P+wdf8/igHRN2BEIRkJjY\n2hokbvc2uSREaNN70xxH0+1pYWWdhGQNFv0fEJ/lQjNeW8E4dsyQnTclLa4q\n+Hgdn7IgIQzvfr6qVqn/275ndeZNviDwdFcpSSKbUMbytW6yftsitZXP48j6\na7ARsHVgYmsMslGF8oXApFLtGRCwdsjVkTwDiITVimZJ+3CYyJDoCXv3T7GM\nPz5FfdNq8FttR6RqN45+24amY/qK/SsZcEqSbOTcYAb8zcgh/BcS/iET+top\nxCjL4Wt1vYNV6ZKIbFwghYnFxSgEnQ1NyDks1498ILxQrsacMwIBDx9z8b8R\nbjpX0vuWkjTqWKmj3OtKYTFImlvEayS58kfTY+l5hqU5RnVqYp71ErDuH0s7\nSgGLLzdjSXFmRdf6FohcS9PE5tXwvWA7+odOdd9UjIvSZE9hwhmy26zevVm6\nRH32IvfwuE6He3FIfJhohYqhU7pYud0ueRAe9KSN9kFp3+ImuoXcYJ1tnENH\naX1o4MoRXp23EOftVeJM6nLLxPv5k2WkDLwG01/ybgCamSc+SnwAAz5712C1\n+t3IGWTp8VQY53aDtNKkDdHHwFqVM3OtVgQuQGl+C646C8rfZjQxAO1ehqbH\ngBQCxa0986Flw6kjX8s/63+TCCboL4X3MmSj7AbycppgSqUuwH6NiJFlQJc3\ntXBl\r\n=lKxg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCVlpU3tuZ6TtkL8yLJrZ4KYDtB3tD7U6q3a0vOZ9Au9wIgaRGrMVRKi7ckf42+EvnBHe/Rd80uxwMV8WE9/RWzD7I="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.3-canary.51.b066573.1_1605794660747_0.9750287563417448"},"_hasShrinkwrap":false},"1.1.3-canary.53.fc82d53e50c23f0fcee8a894468fb30e1f98fbfd.0":{"name":"@sberdevices/assistant-client","version":"1.1.3-canary.53.fc82d53e50c23f0fcee8a894468fb30e1f98fbfd.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"fc82d53e50c23f0fcee8a894468fb30e1f98fbfd","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.3-canary.53.fc82d53e50c23f0fcee8a894468fb30e1f98fbfd.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-HGtdNt71fER7sk44RQnR9gmgVhXUdJwfcPDNjXSq1SOtumszXgyv0Y1METQZE9MjBvxUeR7uaAYpy3kkQcc+Fw==","shasum":"c5f541315a3d79bb37fb5152584a8b3860765245","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.3-canary.53.fc82d53e50c23f0fcee8a894468fb30e1f98fbfd.0.tgz","fileCount":57,"unpackedSize":632865,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftnwpCRA9TVsSAnZWagAAGLoQAIyaUQxEpUCAU2n7M6QD\nQrJDNoqiKL4Qq/Nsnmp8AB15bwQh3V8KUHJEvMrlAlDgucJ6asbjChIelNAC\nYsagEH83UdX6R+fPR8hgGvgkSIfqC+xykboClZCEH2aUzOPnt7WQDvsyLE9d\nauRlKl+ZKvzXvm5Gy6PGLXE5vYngHPGnqYn/8powrO2+zWkbcuEJes5x2rO0\nOtAugfCWqNR9Ctklc20ytaErfu6zMvlZZkunsXoiwS23WB+Ffq84ldXxJ2fr\nYHnKpUshhywlaJ72OvZkdP3FaAQb0TIaFfAUzEsHiobMuIU4ntQfaqi1m+jT\n51zzCa08cpej0H2Rnh8qAQ1ZheJ2g9eu32wSOEbfGPzqjs3qbJ4X5gjVOHc1\npqVy01VL518Ye+5t8Kb5YY1AnLbXdNDYABThQ0BtxxWiCdeKQC7auK+dhyZx\nPWaHiQEhHS4HZuhZGP/5r8d67Fei7zLPD0bdA0Neo4q/+4/1SjdxCwqvXcOQ\nHgIu2lsXiRbpI1EbxPtpe7gKo9+ih0FsJ93Y4pN5r2KvvoC56/I1jbpW8su7\naB7iL57Y9tl+bGwHy1yWIwe2Lfp/jCstIQmjGzfPeNXoxFUyLy9yAjg5n+iM\nsf9BuJHOS0+Uu+gkP//Ci1+taQvoaVlWeZMcDmqm5+5+beGd8XT27h4mS4N3\nVikw\r\n=5D9s\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBFiN7djJSE12I/570cF3S/RK8z11WTPjP5BOKmRPK0vAiAFNBQ5o6zL6p47LaYJJ63t6yKjkG8cjA7oNcsezgupWw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.3-canary.53.fc82d53e50c23f0fcee8a894468fb30e1f98fbfd.0_1605794857015_0.7770047842498322"},"_hasShrinkwrap":false},"1.1.3-canary.53.e4b7570f10a82dc107b62b4222a1c23b1807552e.0":{"name":"@sberdevices/assistant-client","version":"1.1.3-canary.53.e4b7570f10a82dc107b62b4222a1c23b1807552e.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"e4b7570f10a82dc107b62b4222a1c23b1807552e","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.1.3-canary.53.e4b7570f10a82dc107b62b4222a1c23b1807552e.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-N+WHCxjI+ILPnxur3/j0yGqEdRVUIjsyeh8ZCaySwJRVBzOJLtipIhgtnYV+b2zi51iib4QHWwYMFKZz0SmiSA==","shasum":"dd529d604f330d1612d017bae70150c05946ee91","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.1.3-canary.53.e4b7570f10a82dc107b62b4222a1c23b1807552e.0.tgz","fileCount":57,"unpackedSize":632889,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftn2vCRA9TVsSAnZWagAAnA4P/0L5K0PAXozO0ByhbNJG\n0lzVdlPJrhr0PPztqmkYjPjx/+boe82n9efZjPAGcObTcr/6sXNVuM5ew4sI\nj8Xb4xhDiMUrWLDOlw5zeTNybQCbmvv16oaEYXFpT7bHxlUezsp47ZCX0ESt\nEoI1Jh5onbk77Y9TnwFuvRP/lILreOCgUFWpwANSVM1+VPn4PBqEHPuvMTHV\nbIYyyTwfJ+HUrX5YHNqMCWPGYE+Sjd2pOoofk2CulCA3owBDEn6jMpwomOvM\nvN/Y7tO9uKePD/v8RceADsXEav0ZYYKZUMzwvQo+aZYk7tU3ESnz3ZKTb9Py\nultMR+djarZ+Cqaf0dQw728vZm2iX809QJPh+7pWlOqWjZbDAEaTxIaBy63U\nRfV9vSFEUW423HSMuIxYgJs7GjUR9J4kEUemyLF12zN7nn8v5Mngq38iY+4S\nKekTQSSw9KzNQFu96BbR7ZdFD/TV7+wBx6e5V2+Z0JDz5TvmNhIQQ8Bqh4yh\nWYrof8tp1wTgQp+7YJoSw41UtPNmEGjz2UUNHjPCh10OHtkWSQLwXKKzDncs\nd6HsEtWbYocwag1nnyj/nMZRaNwxD/7XQxI/4m4XbNL1mMP+77GV+ycoVX+j\nzgGtik+GNucrrzQq5vIY7ImzL8pVKt+ZQ9EwbOXlx2j9LOTxnST2TyYmaQqv\nvWyX\r\n=nKNf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDh4NB63lhPP/jzWAyREQy7Af9kRtdljh5qcflSPM4W3AiBkOXRuNZQNtw4oQ7gKjertTeK9pwKbLnC211xp1FeBfw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.1.3-canary.53.e4b7570f10a82dc107b62b4222a1c23b1807552e.0_1605795246811_0.0637005485526243"},"_hasShrinkwrap":false},"1.2.0":{"name":"@sberdevices/assistant-client","version":"1.2.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"584562d1923c684808c0ace02b022ce8277627ae","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.2.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-Y49WhIcWJfLRxTkvSvWyAaV/Olh3+GCtwwkicth35rxYs78K36eAeGEAkwXOOBjnNNnYfOvsMigEgr8CIxbdCQ==","shasum":"1033df9cdd6239c63391474bb1db33427dd1dd0d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.2.0.tgz","fileCount":58,"unpackedSize":634541,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftn5MCRA9TVsSAnZWagAAjsIQAI7n+GUXgAFKixWDrHlv\nUspqQxxRtBChj66mwMyRJHpzMQSr/Tr94E4nIme5sDZP5Zyj9hjrl9SGw6RP\nbOBZjX2GuFv3jPw1j6YaM28RESqJOYQAmkjceJYyIYvsloHUCakYaVa6+YWl\nOAyuUn9kuTwYH5S/PgdOZusxNYKpkfyj6ejHREudl+XG6SJzzjsz3cqNUbiB\nINstZ7MkHBstfzG3ENiWAWOXXpCGXmfESryQHWzoOaMGSlNbOkSludvvxnm1\nnLNhjkzeEYqEeXMwpjKsg9XNaV/zktwuRqnsBTeFawWDVTMrTtHqyjVmxlrp\n3Uv9pgAofMfd86Lo0sVCjojlakJ7VzGLBUTrN+bHVopAEFk1Grzb1Y/OlDtp\nNO9usNVR6tI3vnsFZAJMYzOgHjTxWj6k8Ky5d6Fa7y6ShCQjS6ZBs3tU61KK\nQI4YBSqm2a3g59MOW9nov0j7MUylILniExL6FWCCJ3Kv1XXvIZm12pwwnrA3\nwUozgmi1op5KgODC8ZPfv6ILPvSHwYDP3WoBQvgYV95l92CX9fKSaaVwipdy\nBWEoO51FrN58kVyjKMnUbiicmmwnsdY1IIxslj3+ZbEg0HmbMN4FYuC0H10+\nstNr3LF7KhBKHp9bMeeSbUsMmu9leaP0bI0Hs1UgXjV1LQNTNwLBZxVR4ISg\n2S61\r\n=YQvq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGZ+q6b3ANSYJFYTxI2tCXbSLo3BZHiuViMY816quzx2AiEAnRTQw8jqEwt+jOdfOhMLX6e05sRuySOJ3UXrVidVIQ8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.2.0_1605795403621_0.7576615562040525"},"_hasShrinkwrap":false},"2.0.0-canary.47.8d47dfb7d4df197505de691b2762d483cddcb538.0":{"name":"@sberdevices/assistant-client","version":"2.0.0-canary.47.8d47dfb7d4df197505de691b2762d483cddcb538.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"8d47dfb7d4df197505de691b2762d483cddcb538","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.0-canary.47.8d47dfb7d4df197505de691b2762d483cddcb538.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-jG6wnSoLvk4W0+nvcQ9TkQxj8hzQOoZVAPvpX1ycyMyn8C8XJzTl97bc3/iZfd9JORsVs3osIsibYPUq/FgpwQ==","shasum":"55cf9f058f7c5b90b1e2022325d6cae6abdea76c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.0-canary.47.8d47dfb7d4df197505de691b2762d483cddcb538.0.tgz","fileCount":61,"unpackedSize":641024,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJft5gfCRA9TVsSAnZWagAAx2YP/1ZF+5KE65KV/UvWfnxf\n1lQ6Wz0u7OEVRQR7mzGCzOvJEx5PdiyAnxs4axbhYxJ8lED14xzSBqMO+WPi\nENcOAe2Mx0V1x3vlbdgDF2yC9de/5yA3xZlBe3J5o+pGxn+MB9JiIFJDV7P+\nNuFOoMHs47muuqPQYl0Ie+60qUvyFWravDqdHm/19K1X/vgtBGpsaHMtFIZa\n3YtU0Q7DkEJF4/bqlh19ZEGJK4YWftrsjYtojAKTMt1vZNUpPdFMZKrVaRVe\nyU4JeCClesm77pZ5a4dzq0nqQzRmrWxm0MxFrLa/iLo3Gbygc0YpAQGCvbu9\nwopnN+JtbWBiGu1MTEcIJprfQqlY/LmB4xjjqSM9ju8hENAelPtTG/P7c2LZ\n1bzuo07A7qcVcgfZQJJSqgDQ+Qo4wccDeTXBshWugmxT8g82W6bjyNTuBoFc\n7XKCe93qa6yQxCBk2qTeaONmw2YLwI/GDcKIX36Ej0FpwhMBhCGMIuZQghij\n+jrDa+seY2kIaf96qOynch4aynoYJdhXEKVjBSK4RAfGktLok7AsrHkMy5jN\nNBDNA7Q12493Owu6wA0Wvz9rV5nNsKu2RiC8KSZ3iUzmod729C1bx+XlEgjq\nI0ouPnadp0CXZHJ05Ejiq0APZR41XO/ox6ti/TMcNvatigTugAK/6lZCPM5T\nqyXg\r\n=Nfjl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCflpMIhaHml5494EB9wqG5ziW7gpTUX2QnIZ8Fsm6pUgIhAKYhFoZOrGkooCQLX6LiKF/uEwSY3Q/LSrRAEyRGgvOl"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.0-canary.47.8d47dfb7d4df197505de691b2762d483cddcb538.0_1605867550744_0.43792189831978656"},"_hasShrinkwrap":false},"1.3.0-canary.54.784dfe7defe33bdec6485882e9dc64567512bd5d.0":{"name":"@sberdevices/assistant-client","version":"1.3.0-canary.54.784dfe7defe33bdec6485882e9dc64567512bd5d.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"784dfe7defe33bdec6485882e9dc64567512bd5d","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@1.3.0-canary.54.784dfe7defe33bdec6485882e9dc64567512bd5d.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-vvUHe/nNnyL5uPbUr6R5ioGwbKkQ1t8eBa0QvJZOAo9r+ui+ipgDZ9+TxSO3b87ZxoZovVU+b+/92SL55Mu5Mw==","shasum":"28686be58bc0cb3b187baebe461b5439472c5f97","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-1.3.0-canary.54.784dfe7defe33bdec6485882e9dc64567512bd5d.0.tgz","fileCount":61,"unpackedSize":638486,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJft8zjCRA9TVsSAnZWagAAGhUQAITlzsYB68UBSbkApM/k\nx/geusSSXJ645Wiur3FsTbguBj7Y/V0SJGDbfB3LxdgFM/N/9oB0U24x3fFL\nWoAE4ON+nGeNshNwcXTkwPNCtXVzZPqY0wNCWjba2MXqf3AlUeLKI9EH9CoZ\n2IOAEs1RVUU2BtcJ2xG/W925toJaAluUZcm6VeO3xNUTYyYC4Yb9RNJ6XKi5\nbsO+oWzjB0Vn6AC1GHtIf1jw0kq2Np++ijmNTBSimpVnjdBw5TXQYG5RU16J\nrWRlmBd5ZkUbv4clVqgUxcITVhfhOhO3Q1paZEvLAGXa4nQ80EFffq52UO5A\n62WIZlTBmUwuWkp0jccLRvfGIhLGXyiyIk9/aa/B83OSUN3ZD4HiB9OruEvh\nFJ8aYPC4TriPNYD6xRgOhM4mVqvQJPHT5aKQ3OG/eM1S/2qKQ1642MsEYV6H\nurs93LaMfRTNQKPjeSF1yuzX9xq7Ogl8OqMUW0CnR2mc2CXI9x2IE5mLAXd4\nqXl/rRf7QTNYwChwA1ImmNrjQYbLKDetH2I7DnAbRSz4xgvBCrV5ook/57FO\nzufv4m+TWeYRWhy7X/MK4qsOfuDBaBblIpk0/qvSOeH3i2M2gLNSRTmdc1IB\nAxCUqptGJxgc+FAngL9F4zsWRHRYOTxTxULLDZ6C6G8jyoxlIPhxuR0FHN74\nVsOb\r\n=6sIB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIARt9hVr1PQdddGiENpRIGfi+KSzMgNR+LvSnw9E7BC7AiEAtV+ukkJv8nve+iwcbcj3gn0mfIuQckI5YKS7QnIxSRc="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_1.3.0-canary.54.784dfe7defe33bdec6485882e9dc64567512bd5d.0_1605881054505_0.015780357486795182"},"_hasShrinkwrap":false},"2.0.0-canary.47.c89de6ac5a5aaf33bb22f5878af6e2b5d798ad78.0":{"name":"@sberdevices/assistant-client","version":"2.0.0-canary.47.c89de6ac5a5aaf33bb22f5878af6e2b5d798ad78.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c89de6ac5a5aaf33bb22f5878af6e2b5d798ad78","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.0-canary.47.c89de6ac5a5aaf33bb22f5878af6e2b5d798ad78.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-VXvZzDyJLuX50EAM+7kQrW2jT3BNPgyTiYw2iZT6oT2onSQ2DCiaR4UW9LcWmh2XnQ+xWB5GIf31KcTyYLaOTg==","shasum":"d3c7f01d969b859037a70f07d2419834eef3cd17","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.0-canary.47.c89de6ac5a5aaf33bb22f5878af6e2b5d798ad78.0.tgz","fileCount":61,"unpackedSize":641024,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfu5YVCRA9TVsSAnZWagAALDwP/0YN+txnqzPUasj/qOYZ\ntN6iDTzHca1p8kqvmRHItqcY/9zy0+bVy9buFBq2MyKhaa/SL4GN6wIszUQs\nze3Lny22hm93jGPdyo3pAv003QAvpjQiAcrtNUkujwq5N0V2ajIXZf1jLDVF\n8pFV2Qyik7NFqYtaqlSYjH3PJ4nUCvZPbTQobVd9LAT2ViUcwvkdwr9cRJMM\ngempSFxVgvxTJI0Hd13jpvDI0aaai3v5BYOx+rIH0S/Y9YaelV4AU+LXa4bx\n86aR/KuIOFgilR9eblBmMCYJY7qOctYqe6/DT+i+53VYd1yc0wgyK9XVUmLX\nJvZAWXcGWEpxeI8/z9pLKROU99JpYgIcCTmJe2O5UOmaTPj9nTbW0WofPpd4\nCohImnF7FeNNpG2R5IJNBqlaknFAoHFqeUETJKyOGiR78F89FHqiQitUQ78z\nfZMH0E5mMB0PxLyRJbSERMxwLiUFMY1C87z68vi7dWC8m7KHn2X6cYpo2+yp\nozwNkOyg/FCE4IKPN6Ii0qljDRlSbNkWLLg5f7tOMa3kHanUKXMg95sRyvuw\nQ0QUsT1o2Pue3RdD+tUcm5Sg5dFynHKuKuN0/PcZ3tPIislr22RXYU20UohY\n2OZ1X7WMKxjfiBYJA5KX9xDG2BbBsW8PNRVv7J9KMkhwIkw66c8A516Wk/TR\nfMnC\r\n=/yvc\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFh8j6A4Bpo0zNRR8ZAWKa+jALebgPlF+B9O/NB69zVbAiByiw+BuLPghMwQCA9xWj1kvanrv0UcDYTmeqIfCT+Bdg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.0-canary.47.c89de6ac5a5aaf33bb22f5878af6e2b5d798ad78.0_1606129172602_0.16676613820738462"},"_hasShrinkwrap":false},"2.0.0":{"name":"@sberdevices/assistant-client","version":"2.0.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"2b55275d72ff4089f136f7c79132541ecfa2fdba","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-iYYPxhMAnLrdj+MG5W2ekYc2j7FsWCLkAy1HPVxX7E/64YggLrnp/37/l0VQ7J9+D97Qj2OvWRD60FyAN742rg==","shasum":"6c8a437c743f02ef8baf3a8e9fd180e16c64f7f7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.0.tgz","fileCount":61,"unpackedSize":641306,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfu5aqCRA9TVsSAnZWagAALrIP/1FczfMcB+c5tCdOUZnv\n8nMprw1X85ZcgvXAOGtsl2SOyMyeYJUhkPueEMpD8/yj8f6RYhvKiqTE09//\nyXD5+B77XLO+tlpgeEXUQ++Lemd7YWIspnKPYKvLAOiRcNZt1swIjTrVNxnT\nkXmjO3hPVrT6kNti1lPXEOoOHNTOrRD2j+tBn2Ccn5uMQrZ+hXxmQrC+3gyC\nZiV3KIFBLIpUy51nKEiQSP0mAOU/1qecuIOTBxvMmlTtSeU3nj9MzrT+poEn\nFhrntFJPz/e75coIig0en4vmq7JlZEvS+kHbHhLq37Kn9qfrlXhdFtcpjgrO\nL54QRu98AdqBMMv5FS0Xl4TL8X0TWFn3UJxNWK9eZ+y70yY/1EZA90P1loAW\n5+xvMTc8Go+bViwV1ZggdfFLqSbsbrInCYYr6lJLFHdEXCKue/eoSIoJeS8g\nvTGQVMHTDa+As8tWGwcyUSIUiWyMheM01WuCCGVe4Y1QELHi/yXRRXMQYfnB\n74k6BFfHI/TEFHY1TDRv8e26F343mA8j+uvLQc0f17usbGR2vu1IwKiAfduW\nkn+DjVeQXL5JmjTMw1Lw6iN4AU185rdF8rthEMT4qzVCJNFe67Xaz628FmYo\nGP3iBtnccfEpbxyHAa2UnG5Qu1j4cO7KAk59eV67Bx/tBn9uSrD3O7N+o5OH\nESUQ\r\n=HdYP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCJPND4oLIgsRL+Z3AZsvDSikouAmoPD1jAia3PIi0cigIgZFtCZldqoligEQsY7UxWxvZglzD2Mqu7sbeLgv7+rSs="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.0_1606129321812_0.2006091536485206"},"_hasShrinkwrap":false},"2.0.1-canary.56.77d9ddf0032ef997caf6b9132fe21d359ded30aa.0":{"name":"@sberdevices/assistant-client","version":"2.0.1-canary.56.77d9ddf0032ef997caf6b9132fe21d359ded30aa.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"77d9ddf0032ef997caf6b9132fe21d359ded30aa","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.1-canary.56.77d9ddf0032ef997caf6b9132fe21d359ded30aa.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-yYiDUxIxuUEgZx9nbzgaPAEOXXU8VqSCgb+Ubs+UsjCmTCkhnfYxRPd5Ht6TsSQs3na/mKPjz3NUphUIP2bAUg==","shasum":"bd096eef3fc8e2af45c24c9ede7433ae73118c1a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.1-canary.56.77d9ddf0032ef997caf6b9132fe21d359ded30aa.0.tgz","fileCount":61,"unpackedSize":641513,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvN+TCRA9TVsSAnZWagAAMcAP/11CjPOYvL/isx4/i+2N\nPSE/ruhsY2y/79fDA3warVeKu8LehF4IErOfD0UcwxKq3hIt8CfSJtGxx0QY\n0H7LZ9X5aCoW9rx0FzaDUcF9x9njuq4P6opauV1C/JsjcYoVxgLEQocnYQzw\ne1cHRk4tHTxsw3CtHVQ3qvAIccukhGfZ8kfn8eunVp8rtDGKLrUSzaMDKJow\nxvc3Zcs8vn1ComM8x+Ed3QcyDVyo2SB7um47WA5SyMXl7e9WED5xfcLyvP54\nvZ2S9Y6JZwfqQevOYPg056JV874ihRap/Cnt3v6HR3Ps3BzoOndm9jYUUuff\n6Bt0snEFQy3LND5WovMYCUE0/krRFXLCb2I/GKmzNccaHt8Olljqp6RDKKqa\nsCtMUwhbvGOyu7pfDslZzNBrwRDwVDI59BmlPnDuZfH54NiFmgb4aIH5nIry\nv4IKYJrfNd8G8simifSnKZ6OcmcJK+q28nFczA/lG2ae9saIx5N+D264fa6F\n55B1k6/t5hQTLTVhRXlcD0PTcy7nCzTFnYf6R10vLGyfn7jPrihz+SzaUmWz\nu1QDOkUWjc0fA/YUjS0v64UjCancxlHZOekhTxGVTe8ZKQ82utPk1P64Tomo\nClO+GM/z3IEeRC3oycGryMLbp3QWhHy9UdtvDVh2la+mjdqIRrdBz98fJsmx\numWU\r\n=lsce\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDoLmBVHV2TuNjK+MqcSU7cl9mD4wpsTdCyDIR+0wx5XAIhAPzDqTo9TgvZpST4RGYNrxceu5NrChKgtX1BpaNVNkZ4"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.1-canary.56.77d9ddf0032ef997caf6b9132fe21d359ded30aa.0_1606213522602_0.5754931890264239"},"_hasShrinkwrap":false},"2.0.1-canary.56.9d7ad87acf790f295d1353db76998f74538a020c.0":{"name":"@sberdevices/assistant-client","version":"2.0.1-canary.56.9d7ad87acf790f295d1353db76998f74538a020c.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9d7ad87acf790f295d1353db76998f74538a020c","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.1-canary.56.9d7ad87acf790f295d1353db76998f74538a020c.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-2rRq17N3PzkuY8oXluYIAD5K7TBJ2a083AG4kBOtJzzPiQhAeDFR0zt9rc8d6p6ywlxgqTCrOVCLNjUS1+mveQ==","shasum":"7644019b4c5765a3e379ebdfcaafecc7c1a838af","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.1-canary.56.9d7ad87acf790f295d1353db76998f74538a020c.0.tgz","fileCount":61,"unpackedSize":641484,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvOLtCRA9TVsSAnZWagAA6RYQAIDd4lvgOXiSb6uuemMd\nqXk2alMo1Uzz6w2wHmSDaRkCk828uOLCbVc+NbhSt4J2lIbd9P8/nmZg7hqn\nkud79nSxaNTnEurmyeu9LM2uswZn2Ltv2MmSxJSzCYdhU7S1S4TqMPGMaLzU\n2jcdfklOZkkHC/x2Gsxu6sVhvWur73WiRQ1r4YOF6NVaET8V0lzur7Qko+qc\noMsvv4YOyS7OA+QY60+xAgVr1N3+vTYSrxcDBdv6lO8b7A6HsADi2yIIyvGh\nwg/VxE/EMwdbwXVkpxnraRWxLJScxa+4ry+WkhCs3rnk4pxecHX8lX8r5nul\nNQtGJ2SqclnXPY26Jox2bvr5YgaUJhfrE3LVwmX8fv+W2mSM5lStV6JI9S0d\nZs/7m3lhk/+Id2fJjCrL2vg1fBGN0QXYHBFyyXBH1JszglcT6LiUAn9I9vK/\no4f6dQ620hzuSrPzstFZ/nm1pdONBvR7DGvyuBv5feZijuhsldVfqFICENB4\nibz9PGbqUh+BnrtK+llSDOSzye73NVfhpL8J9lly7xLeBsbl/e4eHj72F1Mi\nuYY+t7lgC6ZhjVQ8GVVbBcE7CB3SkXIrZ6/5VRQXmYsc3PYVNFFFPlhNvOSH\neqSiM8j0XjRt9eWdC4wT3ceQ/3GMlltZLsnzVdP7U4L/8FWaNjQtnOLW6xZN\n8AcG\r\n=yORf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEXwXthqAtTfW7azkH6uzEVwANOBnn/Y8LbiBBClx4axAiBpL5QtTB18tjQU92M5B7NtX3qxd0p49B6UHSbRIyfCzw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.1-canary.56.9d7ad87acf790f295d1353db76998f74538a020c.0_1606214381485_0.27159340938444765"},"_hasShrinkwrap":false},"2.0.1":{"name":"@sberdevices/assistant-client","version":"2.0.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"71d27fec957c03843cff63a26a7543fc1057258f","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.0.1","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-D8yd+2XuhOa3A0GGN6Cf5wQLCSRp78tez89iOIRqm3UhFZkPkgljMFEDjEdH/umaugWuj7CZHcELHAeJzFSgAg==","shasum":"36d66cac277c95f52f3a2e0c87f5516cfa0c870c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.0.1.tgz","fileCount":61,"unpackedSize":641761,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvOOhCRA9TVsSAnZWagAADHEQAIIbtGXdy9+VoFiyExX5\n7dzZecwiE/DrBL0hMJjF0sbk9ZlLrKyvGKd8509tWaZpEWztbvCFDF2B3ohf\nxnrKWwM8DUpo7JSxG6ssl6oVYHhith1eLkWQeKSxOGo4+CBEIqYvd96CLoAU\nC2okRTESVPKymzU5BCd7fectlc06m5MyliL4Os7wicmds2O+FYgrxpFhmfWb\nMBI2sitwxmWTpce183WLzclDuJzT4qdTOyHLYr/D1y3mRR+/9TXguF/tfBH9\nt2bOUYDLcaHYlPqyD2uqJLjwn6NhPdCNbcGvDFINwdKpGMlR9WzlQ+aHMnO+\nr/VjwvUk9cJ6j1NgcsONSrowF/fXoA/m2vefl5tRQe4xhxGoIsy6k4I9tTw7\nE8rmieUtv47kpdynNvpBF7bFvwK121r1pWAXH3hfevnDUijve+UE2uA9Dh+Q\nK9b2ZV/eU2matjgNE/Ib7R6PIzXKDYE2qJt+czHfQfQ6CuRfoQkoEzD/IVXe\nk0zHjo8rdhFFvmIgImGUoZEsmVHwWZU8aS5M6LyiODvFmiAk1qz6mVjegKjJ\nIM9zwGxPZVCR+IovdhkUo7XJaEkxaxMYBbuBlYs0xdy6q9xQZjV/JHcBx4U9\nzC52riaxFUZ1yPxMalYtYhxQqeJoOa830Z88GKhIoBUr+K1wk1zpVR3nrZoh\nu/zC\r\n=Hz71\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHhhxm7/+ufmh2d8suVCzEbPw+T1sDAWOX+L7DT5KAWLAiAkcstUwL0gsXHWn8Om+kKZ3UrS1mCo5gFwtM/rvTXfJg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.0.1_1606214560641_0.9840716110869117"},"_hasShrinkwrap":false},"2.1.0-canary.54.6ec2b028f032e82d874ccbe772a73622337614cd.0":{"name":"@sberdevices/assistant-client","version":"2.1.0-canary.54.6ec2b028f032e82d874ccbe772a73622337614cd.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"6ec2b028f032e82d874ccbe772a73622337614cd","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0-canary.54.6ec2b028f032e82d874ccbe772a73622337614cd.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-bOTOooyJxknVyrKZ1CQOL/Fkuea6wvo+kSCBRtbTSTxoVBbe5R6/fwxlkLgpX6rRKjNgft1wxIM5wIptT8R8BA==","shasum":"c071ffc857238e828c694c54b6e7b0be7f54a9e8","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0-canary.54.6ec2b028f032e82d874ccbe772a73622337614cd.0.tgz","fileCount":67,"unpackedSize":654453,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvPOKCRA9TVsSAnZWagAAKTUP/1eLOTDI830n8wX0WFmP\nEnzliyFTdzrZremVM3MVteFxCsSZW3bUsiFRK6J5+BwC5w9raYP6nQWg6lLy\nmEpxrzrDS5Y09mMr89/kPGYyLDxP5dALWW527qYkWYv+Jd1tiF+eLFoxzqLQ\nQDRLAhdu+CPy4c3pwY1XjJIBsFGZTN0VAtuEPM0ap6ousnHa3Xt8tKPFx+xg\n6nw9RiGRouogQ0/p5IYvzQcd0T7dxIcDIYB579IV7jPpWsgdL0XAe6RsrTGw\nog7OFUIBgVgVYEXh7BCbKMsTyBaNWcNuSdmBfZr5Uj3I+ewkchYN8NK3aPHv\nkC8GVO669WUwle+eizvoPvb6RbYC949yyk86sg/qTOoWrh6yo5myJ1E1fwf0\n/LUx8xv1a6uFkRwmyFYvlCCkAWzy8qqomZHqcNYVK4lpyaye0KtsFVRPXZqo\nA3GPQWAHE5b9EFX1SPUF6gUC9TVPXg+yCdpFW8lapQB6huwCB8qG+aqRv/AC\noLumaONK/vzOnVQhcQNhDM/LCWMucj0SjiyYd8hQ98js0MjaEs5NEAOyPSHE\njNmAVtv7K/2d4gpSYmgLeTFn+UR6yLKVy8eLkF9wbTr455PAPdODvTEEiIHx\n+9XsMcdU3h7jAFq0zs/lABB4g+/Ml/PM0nDx6NrlpifBojuZ2DZoPtMd92t1\n+hR5\r\n=/ef2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDNbQ7crJcAoIRnJ9Ei7mTmx9whhUFFtf2Isk16agoaLgIgCtsI723ttLSk66Pb77JOlHj3p+/ASxEUGwx2VCcz5YI="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0-canary.54.6ec2b028f032e82d874ccbe772a73622337614cd.0_1606218633492_0.4916528303168868"},"_hasShrinkwrap":false},"2.1.0-canary.48.ea0c2f160930cb103ea97ab3254ac0298a60de50.0":{"name":"@sberdevices/assistant-client","version":"2.1.0-canary.48.ea0c2f160930cb103ea97ab3254ac0298a60de50.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"lib/index.js","unpkg":"dist/assistant.min.js","jsnext:main":"dist/assistant.esm.js","scripts":{"build":"rm -rf lib tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir lib","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"ea0c2f160930cb103ea97ab3254ac0298a60de50","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0-canary.48.ea0c2f160930cb103ea97ab3254ac0298a60de50.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-PFvDDzQpAIgiFmRARg84IfwEVZiWnbhXofLwhxtgDaZE7g7nIFuP2Qd1AoEFTncnmxqgilOnA27rZu4vf1bitQ==","shasum":"e60f8ef09609265412d83ea5174616b2bda2aeb1","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0-canary.48.ea0c2f160930cb103ea97ab3254ac0298a60de50.0.tgz","fileCount":60,"unpackedSize":1527739,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvQk3CRA9TVsSAnZWagAAke4QAKFI/ZDr0OBYlyxSa19U\n0U9Mt0fgzP1TVmFplaxeD9jcT+kpyklfKhMjI54lfAihR1MTIqpvHwnXkfUU\nLBSNEFd6gLLc8d77THXHNyRWRYZjY26HcfhIQ2PboiLnF4vO82F1+dkpzJI5\niVLeqCf6CoTr2D8a/2YRS1gH/G8qVtu09U7+UbR/aDw3F7aSAYBi+71IwKpc\nyAHcP9xtDZHsf6QA3ytEhFvvP+ZE1mYOpMgDa7N1QWDOnfHG9huWlAy7e3eJ\nOzWUhq8kJHRD8dNPWqpZtF/lbQjXPFtoHTfGXjCIV7LG2eDkUF0b+HWhJ722\n3t8q7KUTbv75MLXsbTdfD9mGefjuJ7HTcsZcbZoK8qwhMjGHCfMb8l3cx7gT\ngZ6Ei9I2WCAzZntQiR+J+/fzZ1EKg6kWJLzaLS0Gcgo45ooYmNX68IBawmQr\n3Y7rpJnQqhU2bXNIEAqxcK72oABpKQMMnzMo1eDvy1Obpt2nyLo7LKQFN105\nUToM1bVJXHopYqel2/Qo86hbMO3hKYb1Xv+ZVqHIHpRhVxY71VQXYUCvyK6z\nXpqesH8y/NcPmuHRa8g3j6kQfk3MCEQc1I6nwBUivUyKoquOLRACu/glgrvS\ntfWBtmNMEPXJsbH0TMpDLnfjFMqWXGAdiUSkNQE2tXk0/+6WjM+YQcRyCTcu\njuNE\r\n=Wr0h\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEdkjFUn30qjnp5Tj1aweZ2fYjMa8E9qOw/++Wu0nTN7AiAjA02Wlod+WqkHJYzqb31qgONhug+a+HiJB1RUWmFkdg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0-canary.48.ea0c2f160930cb103ea97ab3254ac0298a60de50.0_1606224182333_0.8889276729232347"},"_hasShrinkwrap":false},"2.1.0-canary.48.8b9ec1c1c05e3931db0d09310bb38b0595963367.0":{"name":"@sberdevices/assistant-client","version":"2.1.0-canary.48.8b9ec1c1c05e3931db0d09310bb38b0595963367.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"lib/index.js","unpkg":"dist/assistant.min.js","jsnext:main":"dist/assistant.esm.js","scripts":{"build":"rm -rf lib tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir lib","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"8b9ec1c1c05e3931db0d09310bb38b0595963367","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0-canary.48.8b9ec1c1c05e3931db0d09310bb38b0595963367.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-kWW8TPZ+Jv32kh9+yBQYFVJWrO9bCT8GMA3Iq0VVtZwnb3LRHxB5P4/5DHIqerUtjoOh4KOUrHHofO2DgsUGtQ==","shasum":"9937956921a3241aaef14147948b45ed45539121","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0-canary.48.8b9ec1c1c05e3931db0d09310bb38b0595963367.0.tgz","fileCount":60,"unpackedSize":1528644,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfwLCpCRA9TVsSAnZWagAAH7gP/RiNKfXJLNXviKiJMy72\nq0lWggf13xoDwG28TRaesSRT0h3IJlTrruXk0IQVlsJt3CGEfC6lT3vZvWR4\nV4paj8JyVbXmQfvLrq7JEvjnz/CGzzueqbl2pwZZq90Q9SjTNRSaJ1Ef0qd+\nasHJiq4nOW85+ItixIMLfGIpnCwY8LLDL+wKlTcN6plzSV6QAGVd5XTXeZGR\nGbJIlJBdsetNOe0AG96uJcuFTpjfTOnbNJewK3Avm/uQ0SzSY7UV+p1RNDeK\nCNA95lGCmCgDLfjYtgDw5tsQ1q05zUsUx1pv6NWDGiy21qBJpnu2cjgfKIT/\n2kT5Xrv4IcXKDm1n5Xvv2NsMcGkwQ4byaAvfnX5q5ZEobrnJxPGgmpVulcNm\nCUr4E+UflRVC5ipg9Q3YKQstUXhpwET5kQJp2kC7wMpBzmQJQQ18vvtT8AP0\noG7qfnDyCueNi8vPD9VjYAwpR0dwMCWkSqB16VhoT5+QkNd0/s8IlDhY/PxJ\nompPgaX80XwdHHHbst1BLkpTPpon+hXAHY2rMROnzCCFWKSl24JCBcI7rM3l\nFEo5qlN8bAMNnkgIOqf7LP8jIn9otJtYOud/7CnG7XqeEhYB7nfpRrREdNCh\nrkVY5xIR4/wcaT5S0lZ/olQmfQgk1NEx0c4WsiUWNpSwbUv0cAhfTMmzsjvQ\nkZAa\r\n=xBOg\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGJevuA2MX3zRGUUZSMtQfootw4CdSW22bFhWvDVZiXOAiEAnh6J/v1tdomyEe3qiWOxwGvFKrfKe+uAIw4VysYzzyc="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0-canary.48.8b9ec1c1c05e3931db0d09310bb38b0595963367.0_1606463656852_0.7039123404727687"},"_hasShrinkwrap":false},"2.1.0-canary.48.c9b4bd896244a171c6aa949c04c11565d8486fa2.0":{"name":"@sberdevices/assistant-client","version":"2.1.0-canary.48.c9b4bd896244a171c6aa949c04c11565d8486fa2.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c9b4bd896244a171c6aa949c04c11565d8486fa2","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0-canary.48.c9b4bd896244a171c6aa949c04c11565d8486fa2.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-jAzIsWytmKsGSxdbJGUIz6YAqLQyq9d3pGB/lJd41w8cobQNI+lVDf+iRPZEPQ/3je8QAwk+B/PunFSZ/K0etQ==","shasum":"ae2404c72ba1855c705138623af2c7c8d6f76bcb","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0-canary.48.c9b4bd896244a171c6aa949c04c11565d8486fa2.0.tgz","fileCount":58,"unpackedSize":664883,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfwOzOCRA9TVsSAnZWagAAy5sQAJqUjBrTMZPrvrTsMXDg\nhe9MpB855FH4Sjro3lQbIu9shZdvDLUHOGEzMQ5ttH+h6gdb6yRMPH6DON07\neUFmjHO1HmOfLZxqrWLMbgurqM6nfU32empB2ezozaTXyqdyQ4cT35Vx90rP\n49WMxKUvFedZZq/0PZUx4UvvwVjvdkVJwP0zIYPMgnE65X7ii6ZwnfYO+gAK\ndtjHfMjkDHjOwzbuIckx/CmNJhPT1DksJyM1qSBy6mlqiaDI7hJlvpKDkwug\nFLWsjBxbRcVPN/F2DLsofZwfGN5UoDCN58AbvagNU6nv+uyLMMqZ4kkLTyXV\nrs8uknN4pQcW2N2dz3H5j+JTorr341XsfXGrO3hlANN8meS0EIlUk+Jq67EU\n9Tf/f3VTg2mTg9m+vB0TyoNxS9bMK0v5YZnmUXjCb39YaWcFDrxoKxivePy9\n/kYUKe8HOonxP8eiEsAspmg9N+xUIUfcdegKHhADFyNoXpsP2Mb0UiMZHFwC\naAX0PkAWVW1lGNq68+69DX40dTxsz/TEkHr4hmQqSBakjifhpRFk+7e9OZ1Z\n35HNpxVenuY0oWXs5saHgwSkKGvmyysqFHOtoPoSUisrcsZclMy9EcZHPH7A\n+c/ruercByD+v2Qgttfxr6cCp01bfkiU4Qo3vP0bRaa6jug4wksbjCQjoP7v\nnAd1\r\n=jWkp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVpy8NTkvs4gBXvZXhiLO+oRhXuO5t2NtBLRqQ5F2ezQIhAN1XDorexuXt3YJr6EdEZTplidr5t2tJK/cQQyxgHEPm"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0-canary.48.c9b4bd896244a171c6aa949c04c11565d8486fa2.0_1606479053663_0.08454010187026939"},"_hasShrinkwrap":false},"2.1.0-canary.48.6b2c2bde242df6b5fc61c16f3265c389e9b5c041.0":{"name":"@sberdevices/assistant-client","version":"2.1.0-canary.48.6b2c2bde242df6b5fc61c16f3265c389e9b5c041.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"6b2c2bde242df6b5fc61c16f3265c389e9b5c041","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0-canary.48.6b2c2bde242df6b5fc61c16f3265c389e9b5c041.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-nEEgCJrfSQkSVoqWui8ZSuzAvE60PQf9+nKoSLWu7mSULrhmDk/cC8eA4ieMeEyJaJW0Tx9BojHbiu2hHZnnyA==","shasum":"ccb6ef12900bc7b8adb3b93777c7b22f6734f389","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0-canary.48.6b2c2bde242df6b5fc61c16f3265c389e9b5c041.0.tgz","fileCount":60,"unpackedSize":1528418,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfwO0dCRA9TVsSAnZWagAAEEMP/1pk2qC27zyh1I+gUGWZ\nDTOx4Y5apahPCZZy4WHQ5Z4EV/jMfVTUv/6Nx8dvqaRAk9gJNLKZW7Pyy31X\n1e/r7SXxZBeaRmpG9184w90531UKTtDzr+C9KEk9q7IoHBKko87KoNoT9Pxs\n2kE+FFiRZWZWbDID6jin6SJ2/Hp9UxLJ3A9/JBijVChr+i2b4AFhRo+VurD3\nqrBiQGWn+dLBg0IMb6gHzVEH3QoVWvggj082ctsc7X8SjE8ygvc3wbV5sxRz\nkZNGvEtYo4UXjHvarvSAZU3lZoPchyfTU3tthxLGmnDTsfoqVL9C0EKuyQHL\n8C+RH1m/3VZr7FEIDizMS30K/zD5oZknMsE4QAuQXn6sFVJa9ZmczdM6SEff\n40S2SuzTXliLxa8XB5SHljF3wrucAG8WXg+toBrtHAF8NZyJlpw6RjFT0DuA\njPvGbtiIreTmbM4X5j1t+2js9FOeKR2SIj4NpxLm29Hw/ZRpmxHI5IZUOoU6\nbVTAgjW2lUuPa5QmZDSBMp6b69/3lRSCn5uSTheE0L8b430MWE4eCkDg9dID\nUAJzziCruaBNhT+ou/A9z/7LYdKm/TYFa4Wv5VsC/DOKdTglSe2DLhJ3eoHD\no34GGFz4AxbxP2aP/FSbpbkvDpZMeGmbyUUFfbB4EJ/b23ury+FE4Nme7R0n\nzKkH\r\n=RuUN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC8ffz4Hz8J+QOIrjzKBY9N9roYkszqxFt+1kfqdh329QIgXgx854ZUgnTENDvR0ZQ0fTih0FSSok6lsq4ZBcOUkN8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0-canary.48.6b2c2bde242df6b5fc61c16f3265c389e9b5c041.0_1606479133073_0.05505151175744749"},"_hasShrinkwrap":false},"2.1.0-canary.58.03ac302471e41b44fd8a93a6dac19b85a3693042.0":{"name":"@sberdevices/assistant-client","version":"2.1.0-canary.58.03ac302471e41b44fd8a93a6dac19b85a3693042.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"release":"auto shipit","prepublishOnly":"rm -rf dist tsconfig.tsbuildinfo && tsc && rsync -rlptgoD --include=\"*/\" --include '*.png' --include '*.css' --exclude '*' src/ dist/","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","ts-loader":"8.0.4","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"03ac302471e41b44fd8a93a6dac19b85a3693042","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0-canary.58.03ac302471e41b44fd8a93a6dac19b85a3693042.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-8r+PuFMuVziQTF1RyaXHusFoqppLxq/AiQYefhZ6LNYdSmYIjCUr17jdYUMgu9ohAG3c7TI2nEqnR3M2IS0KCQ==","shasum":"f563bfb512dc855e15e2aa86b86a0ed4c8389f4e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0-canary.58.03ac302471e41b44fd8a93a6dac19b85a3693042.0.tgz","fileCount":61,"unpackedSize":642553,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfxMOECRA9TVsSAnZWagAA/ewP/0Oh8XFr/4RQNJl+hBZh\nMgHycqMk6MSxgqhmJYdd2Fq2pTxa2UeixHOPz6Hr/IhhKfw2Skp6gLpUCV3O\nWZ5Hz2Y0oul0CHm5Dj5eiwMgzSh7sah00aQyASinoYYUga6CS8f0wJiSeSky\nlhmuvO+n6mnmXpP6wkcrvtPCtPMpxibgybkXuG1MEkwAQ477tD66/ibFTZo7\niOvY9+tFaBxF/u+aW5ovMlS1iuoA5nc/HVEX8deKd/xghwzUdp+tOsU7b/vK\nCL837FM4YpEG/vUfdIUubkpVm4hKqmK83JpTht3FUQugae3oRh83HfSpFzfs\n2OQu+0DMdIG/x8OH6MaclFyHQNSkx9jP72I+gsyXdauQ7bBK5R5J36ioxr+F\n3/6yygHZ8esV7JnZFf82XCYLR8RnoIf0m6gOozZ5KJMVcX+XLwZg2AjwPb/k\nc7YO3kJ11VHA9YlDCb/+APQ9xt4pcT9sGbLBdmpLOfR3pH4Usp6KIxdrR4Tb\nooWQtHHoI110VbawuAZJvqvA65Mh8qPWdVzvwadmz89U0wXmUFXwqBwvzotG\n1K6K192tqxIJVSQES+wzROjE1sL6uymEBKZZL7mg6LlDi+APncIYL0zarDVv\nbsf7nCnhcwzIAx1vwY1x0o/axAzE7kE4wtp+Y8KkEGAeoHQ2DeUbboiPZK+j\neAdj\r\n=ODKP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDSDK27/merinbYKQVrbnX18b5svMf+Pn1W6ciWXbvlFgIgD0ZJ/lPM8HQFJbVBGpI8kPbTesJRH2fAa3LqYsGzKwQ="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0-canary.58.03ac302471e41b44fd8a93a6dac19b85a3693042.0_1606730627331_0.38568864099221223"},"_hasShrinkwrap":false},"2.1.0":{"name":"@sberdevices/assistant-client","version":"2.1.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"7b148369270a0a204e38e66b0e1e09b34317c494","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.1.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-gbuediGbgYXSK+A/c33lw1nQWUUFGVHghWSlcmxaS4yskSsdRLnbpo66hIek6QkU3ecP7Zl85vZIp3OKI2dCYQ==","shasum":"9e7ff347710229759ae3bfb02d402295d7b0476a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.1.0.tgz","fileCount":60,"unpackedSize":1528790,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfxMfACRA9TVsSAnZWagAAEaoP/2d8uK5dXt064czMHDkQ\nob1nGGoFUbMjWvBR11OHKowsnlPUI1PrGTMoXMEtp2pZ0fR2S9lsga2e88oz\nGpsFMOpm69FYdb6xurTOhldYHc01cPVE+MPTHhDGUARwP6Xu+QP9fzHmZ+3F\nkgRqddRaY/oi+y7A5C6aH6WoyhBmTPNMBMTUPda0uwJLl1EEv/dToGt05dOc\nYUJji3YOwL2pSRN4nqVI6tk6nF9c35157gltB1Kx0pq+7i83LT2iU6VNQOgm\n7C98lRX1grR9Ok6sLVXhA2oqpWA7jwD7oJ2oDsGn7exIM5PCHbTPBc/3s9CT\nGKpyVyPSbecbm5rlLE25n0zsJeeYPkSw/37nGT7h54/RaXVRYd+7UWflEezE\nTG7ZlJMgMvc0PUwV7THaN6kBUt3j8nDNfxiUk1CW5UdNLgXZcJLM0qRsCyIQ\nu4pp6IIqLWGNgCjj39RbveY9gHWjHQ7XyTekW4tvItdZdnyeh1bF4DGvLO2P\np/Sn42Dift/MKh2GZxDaXVA6mAQWS/8M4mOSvccqkq3zMduLdKv+Sh/erQZ9\nN8yQStq0bLuCVN+SC/iwRN4ERtj+SILXO3Nn1xDbFyKJzmuZ45GyGhdw0p5D\nx6aNJnX/Glh7iK5+VmDXNDxUbLQZCnejRf9CtA4nRhUx8aMdbhL/QZfYwcbD\nCka6\r\n=fxED\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEXv7QdSZJGJLwpxbc8ZN3Ie8VN59ZMJU6cp2/SeeCxdAiBfwuSqg8EQqHlM1Vt3S/kuA40g5hEHpj/bzys/3Jmglw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.1.0_1606731711801_0.5512223390059532"},"_hasShrinkwrap":false},"2.2.0-canary.58.f73e9ac794e22bf14a958314a79b9a47704e1438.0":{"name":"@sberdevices/assistant-client","version":"2.2.0-canary.58.f73e9ac794e22bf14a958314a79b9a47704e1438.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"f73e9ac794e22bf14a958314a79b9a47704e1438","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.0-canary.58.f73e9ac794e22bf14a958314a79b9a47704e1438.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-JqzQ19wdpKGaG68y1YmOTsB+AYSosebzsJ3gq6CgbJl1zkHC7RHIKEB8eFId12+EwK7BrYq6j8KRf8j5LqCfmQ==","shasum":"06ad44f468d72f938477f29cc09d7c5e2302e18d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.0-canary.58.f73e9ac794e22bf14a958314a79b9a47704e1438.0.tgz","fileCount":60,"unpackedSize":1529348,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfxNGjCRA9TVsSAnZWagAAc6gP/0Ff8uYSQPMyAfkc05OE\nqcy4QKEXjfz6wFcDIClTlE52XMTBU4/iMSX2fMvC6fvCmw1LhhLvyoTQqnYG\nnRnoVE4+jQU9xMhNXIrCrw8g5GvwFMYibE3roA2XqFcpVd0KXCxhLcDhB7qC\nQ0oIog0AUqXvHwdCF070v5iHGQstqa/THQaxiRGa1IWOX7k0LM1o+300TE6k\n+4WnoZDYyHaXQFTUNb6n5mzfmMaYjiyRA7ciFXXsOWkqPL3dH7B9vSl4dFGK\n408//UqvyldkK3FzcI0/7ouUtVrgWb7dY8dI/Wmg92q9VKsi4d4JMDvGQIa1\nyhrSFnzVbJpRMNzz1JgleE2AyV56Lh3IJCalVkJtHJpud7D5Qxa4uix5LBqC\nj8CoYkCRxbT+2+3dyOJVVri1p1wBEGDP47zA3QvY711MKIYwF9QukvLMNXc/\nvG9UBtmEDeh5CtT42GhJ34kWqbhm5Dlmnem+Zql4bSreAAW51oDOMJ0uvNly\nO2XsHvEiOUMzPmiddpLTa58UplGuJeepCsf77NEjKGYi8/9mffLrQ1nWD31R\nPVAApywwyidlFDdYEEIxPUj2tkJOcianYhcyLDVWuR/yPZC+7TFH9X2Xlo+B\ndbEDVAC0gNuBio0xJ5TiSAZPtwSXqa6UXNo2OtxZQkEjmAF6pJTeZLTrFt83\n5UKB\r\n=aSSe\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCfe1Pld80sXyP9Y2j3L9/T2fpaN5DtAYn8RCLwNHlWDQIgI2g9KFtyMgZeRf8Ij/aLdvzUSLG/HKdjB56ZJdfp+ac="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.0-canary.58.f73e9ac794e22bf14a958314a79b9a47704e1438.0_1606734243120_0.340660572650787"},"_hasShrinkwrap":false},"2.2.0":{"name":"@sberdevices/assistant-client","version":"2.2.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"ac3a809e62253ac0eaffe079044fce56cf6cc88b","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-dOQxRbfB2VTFm79AyGhYUZJ3wjIMC/sehjbToSAB/MUjJJhewN3YMdcA/+Oe9Xfm0hpi9avNctMTwf8VPG4aWw==","shasum":"86de81c65eec54088ec9b5e3c851fbd0f8193498","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.0.tgz","fileCount":60,"unpackedSize":1529632,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfxNJUCRA9TVsSAnZWagAAk04QAJvZKvOWJgdKqxBEtEyH\np5mUuevssl3SRdlJ4Lm5nW4IC6LLEjxdvCbR5B5/xkX9FTa+UpcBw9PTsTtK\n77LT7d7JwtQv9Wg81psLXvKb6nmxy1hdDnAopbhXGuaRWhUyPJmjMTdByCp8\nXGrb5ZOZR1HxDjfQE/Zz3w1idZb1uXHMHjUgh82Qvur1V80yyz6bQ2JK/i4+\n5Pd8/1NTHHAk31jfhx7528z9DzkgYpLStRzuOJb/ehpm5Sn+NFvhg5cNrSHS\n0zecq6NTKBdqoHFpE00cGc3IM8Zb4Qrz2YHz44EcT9QnvLlEaB5nn5igN3qg\nG4cgVuHKuaWg/E84OGb20F1KVH0U126sgfjqaBHBp03w8Uo0+zjaVM7UOGYT\nUFQI68r2+UaRxTg64TmSghV04pK2ouIFE6Qxe8IK2uF58Q3iV/Hwi4FYtyUY\n/4Rs7lEsyPINVFFcxu+TrGp5zequcJhk3DVPR1DPswh7eadJnoQTdIljJoCu\nF8hS/owMcXZDUQ0tOixlw4sjjnLGpqqOoDn17TQtak2JqFYf29vG6uQGJZMQ\nXyYWJbjK/sMCcT3mYdFFvvluYo5Qola+tQIK8BfWfEjB/DQQl0yAy6a5UImB\n4DwYcrc1UDxFd9UYR30uvobarnxn6sXrjViGbs0D5rAJpWBMAA3PMwTGSG62\ndBug\r\n=1b9Q\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCEonuyD4sZuNc+QouBFfA4pKAh9W31RgfgPHsWszeABwIgEPXT0/dJCoku/Uv+YQvALV688tc6GmTD5ofEpLKgPJg="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.0_1606734419903_0.38780807493070135"},"_hasShrinkwrap":false},"2.2.1-canary.59.5e777c992b8bf1d16c3ebee65339b06f53dd4fd1.0":{"name":"@sberdevices/assistant-client","version":"2.2.1-canary.59.5e777c992b8bf1d16c3ebee65339b06f53dd4fd1.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"5e777c992b8bf1d16c3ebee65339b06f53dd4fd1","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.1-canary.59.5e777c992b8bf1d16c3ebee65339b06f53dd4fd1.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-vz/3SqJ0uI6jiELUe6glRMwhozy0PQAwxVlRJSyyiwjNIOgJN7HS5xsw7H5Bv52IrMm9tvMbcg3WWO0sdT0Oeg==","shasum":"1068a9c72463de4fe69a4586ff0f7a9f0cc03e59","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.1-canary.59.5e777c992b8bf1d16c3ebee65339b06f53dd4fd1.0.tgz","fileCount":60,"unpackedSize":1529877,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfx1lECRA9TVsSAnZWagAAnVcP/2VuEFvYfpyrDTXk9Wpn\n8wMB5hKOU8GZu7O/laMpyN1XibyFD0qVDgXesloGhoQdoL+9JuttueN88aiG\noOqDZ8Skc6ZCpjbGfs9EomPeCAUJrxq/oxirrFX8+/IpazhYDeTSuyXSijTa\nB18gAUynhx/iVvj09ErC8R20JyHNXAOhAwnlpnfKWDxnp7ict822I5XGIyf9\nO2CbSx2kdToJRf9wmlCaqrIsXc6RpATQU3UlqSUCK/4JRdy+r2FmnJLyY3Pj\nhqakWRT7ZIrvOhZxdJpfAa2HruTTFSVM4/b49hJwfEE2O48rpIf7sDPbHdfV\n0WKOgI/875+K9c7MQFRG62jpLQGJGYKOeffsRyefoOChOmndgvabfnpEbfff\nJ4Yh1MTVvgbHwmQNA/uBu60OCMcy+h0i8ZSHQzDiQUU5YdSqH2l9UHKTXHUB\nyqKpd/RzZAnL/j2vshBrbYMNkri+h2CYfRUJsc3dnKlsfKVHYG+4RUAJCTc8\n6ExP+x9006H2xCp6AwlEKGiCB2TrVwW2YQuNrmDEbgFYzG7PE3FT4IiBGtuE\nk6zmuwXxCdfzA8strP9jsbAq9/9Eig0CQRtSBoY9PWTAtP4fdayZ3zqWIOYK\n9sH8oVDreFZyA7a0SVstScgiThnbE8E08hctFU5Av1lyXcr3tTieKvsm4N7I\nNT5s\r\n=akOp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHusdcYr8T2P5INBgfI8wjbaagiKZH0qql2rwMrhfZBQAiA9IhC/1InOaXGshv8xHBXval6ERQoAFlbys0UDY+ZQTw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.1-canary.59.5e777c992b8bf1d16c3ebee65339b06f53dd4fd1.0_1606900035385_0.7005721581847932"},"_hasShrinkwrap":false},"2.2.1-canary.59.512fa8aef00f263236e660625d2208293d6b4372.0":{"name":"@sberdevices/assistant-client","version":"2.2.1-canary.59.512fa8aef00f263236e660625d2208293d6b4372.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"512fa8aef00f263236e660625d2208293d6b4372","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.1-canary.59.512fa8aef00f263236e660625d2208293d6b4372.0","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-60T+BHpAG6dnUP1XJd6IfqQwW6iHd3C2na0I7VkBP8yUJQ8xHy1+hs8c+D4qQDJteLHhMRjAg2Dn9h79ef1tRw==","shasum":"d66684c6ceefbef15f254c92e1e6ab61aa369226","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.1-canary.59.512fa8aef00f263236e660625d2208293d6b4372.0.tgz","fileCount":60,"unpackedSize":1529877,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfx1mMCRA9TVsSAnZWagAAGX8P/i/UtFgS185a+h071Yo4\n+GzFHGtVSxcVyKQMISCvkA5luokhugFOHX68HmRLnf3Nqto+VWgwARyH2tg+\noSkbdNCUlDH/sqILkXMjQg/bjslsGcMHsJEZ82tV4E/13RwE+WylJ5IS24jD\ncR88ZCepOeu/H9a/355Ct9oiznX210deOzRmp2RL9GT3H4s+V9t4wwdGw/qC\nxsB0B85aX1eKnbImqr2beTakl0i9LobZb4fBlhbYd+W++9cRCGC05anA+dgu\ng62L3iSGlUFkdqRSqGqwB23q5nf6mqElB5LmR4EblWB81KbeNwVzbwSGj4o4\nW/gbQ3PQJMXlBCg5UQoVRsMyJwFvMg7teeYswyu70hIpQ6DsMRyj+6aRtv2R\nTGcA7aaZn/KU/cioOSs6SI0GlEs55JFWpobjntf3dZorB1z85/cuQg+n3qGm\nTIaK7i2HtmKGXUzBQ704icPo/3Z7XT+s8/hTMPVVIDPW99+OvB51GQXi9vZx\nk6/g9aVPGa44ZT0COj2R0oWaEB5maK9qWgs4rZ+JXSIgYRh7n1kp31rUSco+\nGXX/NEvSi8hgq3ntKf7j2CCUlqhzbVQEKEIoP9Agf8X4AZYL255agKeNubqg\nD46hcm2B5xtPJoWf+BmSgVa9byshRmd0tKNGtuuo3tIuzgsaA+rimFGZ+Bf9\n/lr5\r\n=LPhT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDS+Big15NkNltavXt5U3hoJvP3YI+p6skoBPtSNRDRNgIgKjXwWL3kTk6+o5w7tkCLXewXzuYroaNU6tRyXXJ7MXo="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.1-canary.59.512fa8aef00f263236e660625d2208293d6b4372.0_1606900107459_0.1872049457863696"},"_hasShrinkwrap":false},"2.2.1":{"name":"@sberdevices/assistant-client","version":"2.2.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"ff46c9582009aee656b46e6f2d0570c57666f22d","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.1","_nodeVersion":"12.19.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-BwIBtvTEIDY6GZW+hjQSaJQh6D+SYzsgD2OD+zmYmpP4nIzb5vokdv36zuEhnm9V8rG11V/8ZN7XAyPl7Gsr/Q==","shasum":"382e233334bafde4eb96e128118b239366108733","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.1.tgz","fileCount":60,"unpackedSize":1530185,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfx1pBCRA9TVsSAnZWagAAyaAP/R516J+zk5gvc8qlbefj\n3Azn0N6hKFG5kqrgRx62+ViAlLhs++W56uUnMx6G3uo9edjBQraaBeTSTwlS\nMg9kS/t74AjL16IYec6tsMatQ559XXovOGmW6Oro2yrVM2uUX737Irgomx01\nF4Lqkyrk7ToWGrGFky6bqHx/Lgn+FxFAtnS7e6cu44CMbKkC8CHncEqIYv7h\n7neCONy0ypV12DHOukcE02WsxsQGALvthZ409WeWrc5lWYLYsV9/ChB0e2MX\nV1boq/ndj0SU5zf8pNuoXV7wwd5FFwX7FNT1Ds6CtpBe+3yu8CH6HwV/v3gx\nPYNhv+X2Bh+OBn7G/RDsSLBeSuKMdQD30KYKhoS3/CFagfqg2Kg6pYHBlqjR\n7dBIicwkQqjKox35tfD8YU8rqvmtSv3do2ONWOpSNXMDZcQA64CiuJBpmWC5\nqF5q0d5J6tdetQj9xfKO8sGoqTccvmm7QkRtD1RRzfo+nuzpmnet9/LKuhCi\nV74B2V6rErtXk7Gdxh8oL1QT78A/igzzMbaqwEZ6yPgRrkSWRFOuKyOKe5S4\n+yzacvWKuTNctxJ5yU/exmhfktcDTJi/DWEswLI8claaq9nAaka7ZCAfEF8Q\nHBsGwl9R2SXSLAus3HTNIDrmcIGrDpbw4Q1u3jWbv4O0fBSNtK12hgOIZ4os\ni9FL\r\n=9J31\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBPHPFF8OImpJ8AMfqqtS53876Swi8hA25s/IO5pS2IoAiBTlCy1j787fjPBy84VbGNK7HSdYGFrXdL/ceifFfiodw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.1_1606900289215_0.3790873059585407"},"_hasShrinkwrap":false},"2.2.2-canary.61.7e255dd5af0963b445c3df1f6de5bd869fd130c9.0":{"name":"@sberdevices/assistant-client","version":"2.2.2-canary.61.7e255dd5af0963b445c3df1f6de5bd869fd130c9.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"7e255dd5af0963b445c3df1f6de5bd869fd130c9","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.2-canary.61.7e255dd5af0963b445c3df1f6de5bd869fd130c9.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-fVmYcfaD0QhJTFZnPi6LBcaNzwxhkgOzT4cOdN8xrEZcZo7I2TqjO/eRcflpTxVikoSGhfi5+FbkZQE+7FrclQ==","shasum":"0f9d7f1aed759d03c0090915e15fa585bf1cbd4c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.2-canary.61.7e255dd5af0963b445c3df1f6de5bd869fd130c9.0.tgz","fileCount":60,"unpackedSize":1530474,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfyNl+CRA9TVsSAnZWagAAVyYP/1c+qSjIDTwPTKm03dDB\nPYgKWWsaL4exfRpKHLAXyJmFTwyVTWhLILy2cDL+3uGsfYrxw+FuvBbxs01A\nM40hoCr652mLySGkvma3QsjP+C765kFk9QxSaKXRs1VNQUQZosXHdbbJhq91\nG1zQlbHqnm9u49iJ39Bew4I7ev3yTESxpPVdCo6DGtr4U/fRRaOLwCjQVPbY\noeD5DVk2CAMSxwhYrwhU11WR8mjf33umdE6yn3LuM1DLJsfTzTZ8e5L8Cs53\nrPrL3WS0Z7yB9SWyrJSd96CoYgyuEOZl3ZuyDm3xzyTXaXoGM2o0n2fMrVRA\no7wKK1dN/UxOEiDAFEtf4ECO04nwyfEb7fWQcAOMwWYidh7QEBBZURmWWxtB\nBiv24kbNmY4XAKrfcthnqiwHYnsWlIlUVWeWTQ2GqoUV3WxoO+iA6UL7skK8\ns0ug2ORGlwOsoAQarOzHRmHPH9IE2uLnhLN+n5FY+YSsNyObxiLyzavY7qhP\nrOvRvRYaxqiUc/5SbdtBVofVCW5CYIwPbdW5dYynQB4MLcQTptP74bO2nioD\ncJwjTnkUxfSRbmkiMQ170EPhddg1u6h/06UV5gxVSYYwBI2CfqqEEqFcbFWc\nvNc41TsewFCOLK2R0hZWB1IiugbnPZ26aXEuH3IAWNrJC6XYJqBdlASgPWtf\nAqiq\r\n=rrDM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCUkzZuei2+rgSLO6P3qS4RQQ0CnY9CVoKtcG0gdMOE3QIgcF993JiIyLosPUJZk0QHmjo/aNTvSA2x45b8lv/eHrk="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.2-canary.61.7e255dd5af0963b445c3df1f6de5bd869fd130c9.0_1606998398412_0.3622146807301809"},"_hasShrinkwrap":false},"2.2.2-canary.61.6fa0c86f0e801048de7559f882ebed9e26c2ef4c.0":{"name":"@sberdevices/assistant-client","version":"2.2.2-canary.61.6fa0c86f0e801048de7559f882ebed9e26c2ef4c.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"6fa0c86f0e801048de7559f882ebed9e26c2ef4c","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.2-canary.61.6fa0c86f0e801048de7559f882ebed9e26c2ef4c.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-P49m+sMdF25eyAS8Oh3oZPWR2bYRSD5Mg/ZC0McHLBP+gXQ4bjjIlfI1vHwkhL4o8JIpNe6FViVdvG0D3sERAw==","shasum":"dd0ba2c9c4442896c433f85322b40511883f888e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.2-canary.61.6fa0c86f0e801048de7559f882ebed9e26c2ef4c.0.tgz","fileCount":60,"unpackedSize":1530474,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfyNmhCRA9TVsSAnZWagAAyd4P/3hdTUE+zYGE6sMpdxQe\nmS1XQ9kdOfsd6uq2/JpKAYhoqo5IDNvNsGwUE+L9e5g5tKyN0TDyoW3LcXWS\nlRUExcWdufuFqP80utVh2rQEEImBH1f0Zjw/kXBAMuOiO14b7kKTtyLtTyTT\nJWYm2NjO/7aT7NlXBqUDkrGrAEx6JlW36KnXs6vuvG+94Zjz5QXJw9eW97XH\nsZ1weszZ936HkcA4H7vg0Aqw2LgJlSrHAc81KjDbkU9CkB6giat079g+siOj\napWSJN06Q2+XDohscwG4hAtHe4dnj0W5PSQfKurje4gE5Qt2H63sU5jNO4oK\n2Y/dstXmMLveetsTg4E2LSdvbb3Z3kwVykB0zFN5MjuW3yYWNya8PXr7bvxw\npjPKPLPN0RRga//+b9pJxzkS/lDZF8oMkUBkPxJlPcD5uqmnBRCF6oYr3Iiu\n5jhDKb+TSA4EZGDT+QdKsPGJef+WJKF/AhK3pCi9i+rS0b+QBz5lCMN7Qqvq\nO6XiozD39+JxoOtQQ0Y0m98Ft58FG3DZKFanuYDQkcLeWcBeCu8kAm1B9ceY\n+jumWan50P/c9HDYAd9xBmiGxrmqzo+uqz7+XmzM6mIUf1+0QTcuio0vGws0\nn+FzfvtcNlSK/kGulLGF0T00PVoMFkK9KPpic934CCl2vcEXFEpQEDSyj56m\nCilD\r\n=EBqb\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAwVOrJmOjkXMdADpRICbspDTrNRHmasdQ+5GJjUX1fmAiBgMDT7v/VjclJbkK16pYX1UGVkGvOM61bVE/5m6AxYqw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.2-canary.61.6fa0c86f0e801048de7559f882ebed9e26c2ef4c.0_1606998433315_0.7580874103529565"},"_hasShrinkwrap":false},"2.3.0-canary.54.57b4fa4d7264c6071f574dc1dbb73735dfb2fb1a.0":{"name":"@sberdevices/assistant-client","version":"2.3.0-canary.54.57b4fa4d7264c6071f574dc1dbb73735dfb2fb1a.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"57b4fa4d7264c6071f574dc1dbb73735dfb2fb1a","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.3.0-canary.54.57b4fa4d7264c6071f574dc1dbb73735dfb2fb1a.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-geUW5oGA4F5SKL3FCDovjQ8E1Izh1nbxAlXTRl/nfLOhGUu+8gcZYDYG1UNrfGLYT+2SnV5oCuIv8Fkl+66RDA==","shasum":"17b3efcd32bf27657c448f3892fe1c2dc1c9a212","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.3.0-canary.54.57b4fa4d7264c6071f574dc1dbb73735dfb2fb1a.0.tgz","fileCount":66,"unpackedSize":1556677,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfyePyCRA9TVsSAnZWagAAISQP/2ZemX5pHjNj4TLqMVBY\nQWzyYmnwo0FsSgBkAPOpNTVwqb3wmVWGJFitEIF04qEbw2XlNdPIKUGBO3qY\nO7WaO/TJHZgs57Wo8CV///1PA0FZh8uX4RNhuIPTE10OwQ7tsEjlqjqzMk/N\noTfH4Hy4//xbMl6cO+hTTzu8+YGvUQvijyh4ldnF1K+c5qoPmfiPJnU3hT4r\nNA0GZabBVpDMtSV6NUEjb3dhLYcoBwh0pkT1pKmGrlb0TW8aL1OZlGa/jz28\nHobi+gIiN1d2XsMDEDo1MCIKLql6MN7q8Fxp4LK6bJ6GHyoSA1BNRy5EZFIy\nInnZvceukjU/jBd9ENdeIG8wkze/0ghNBAcz5geICAlMODrhVrUvCV9n9eF2\nBnnn+KAh14LugdC4NUcNHCAkWEBCYJtKC8eMcOxX/VIoaVlZBPr1grzadziS\nY4TU4wVQuwjCc5wyr25GHvQU94Kyr91VjJM8fPcgPi6CuZZUW5wk4b2606X6\nEW4V2lXzn7pQLD/FarqSpVY5f9BzvwfgpQtlFfTU6eBqLG7mJcsJj04jjV3e\nRm1f8wAuPKl9onO425xURCHHttyydU99/SUHdaKOI4sIasF2vu8/HkOutpCQ\nKL/9ppyjcBx8lTI63bMh3cgBG5SGYPpaksAPjNJVThTGHdg/gFuysoDbyTw3\nu2U7\r\n=KuUZ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDCUWhuqhJb72oTtRv3DIQnGswyN1YKIoFx4NFuPO9SZAIhAL3ad8EtRiN94n+tASf4TVl+xLfsCfJ11gScdpuNlGzz"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.3.0-canary.54.57b4fa4d7264c6071f574dc1dbb73735dfb2fb1a.0_1607066609823_0.9941825034167451"},"_hasShrinkwrap":false},"2.2.2":{"name":"@sberdevices/assistant-client","version":"2.2.2","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"e0b80642e4a6f87f68ec86d120bc3a36bf16d453","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.2.2","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-nmWqjejFOB8Xi+hz0gSLlGPKfsDzs0YYKnSWJnhxKxMZP8xq6tcvMpJ+/Bz9WuKpadvHl/CCdbfyHMIuLEnJDA==","shasum":"38e76253d6a71c7d410a7fcf8079175964a67c11","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.2.2.tgz","fileCount":60,"unpackedSize":1530713,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfye+XCRA9TVsSAnZWagAAWlgP/AsTKWcywPsBgo5UA5sg\n0+Ct38Lu5yXW7/5Wc0jVNB1U5SXvR6gmyHHgucBafqkNzCYDaybNrcytqNpX\ng1nfOhsfsE4LbaThrb54HbnkjsxCrXHyei25T0t1lUwr8M1iGckwDg8rdYW5\n4V8LnVpaiAQDk6D9l9sq28XIokh0LUZLXlsIVpOPb/V2z58kU9wCjLmRJuGg\nDolgXNN1RaJoiV6OlzwLTqj7G4LXK3ynO/lnmrcE7Poh0KKjrnZsKs6HvWtW\n0YD9cjcs7aohD0hUjn7bwd5Pd1WmCZA2df5464TdrwW7sImW5eMaADkUo1RH\nFz/uXmbY5/G4qSOzWlj17cF3AyTrfWk5KFUg/mQTqSo+uYueMbp7rW7QUWNl\n+1i5sozgytoUKnIXwi/IaRxq8jQaLjkVoyC4qJ8b72X7jzhT8Wy+BCDwxL4X\nOT36bfC9TegiZiGYkqMad2S+Y8W8vA2EwbZhH8ke/ABW5HYxSd3kwR1AUozZ\nwNSVbZJgZnYNzgAk1NHeilrQczLFcDYvcVUe8gND4ieoDm8aoCG2Nl+4wzDI\nWqN0LVE4gj7gosjf/LtugFJOBKMxsqNmSVF4wJVP7Td0a8Rv909fj2UuNmFR\nhVThOxXtuRC2spgH2LsJBvnrRucAsyp0+dAK/9Ymv5oyK03/ufytZlMd3zkO\nbK1f\r\n=GNah\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBSDtJ9+RFeBxwTpwT8zmUuy5hZH91mcK8qiEEUyYQugAiEAsiZrOhcvFgQUvbFEdnjM9Rynw66vZw7VL35ljJY8K1E="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.2.2_1607069591147_0.31585556149900995"},"_hasShrinkwrap":false},"2.3.0":{"name":"@sberdevices/assistant-client","version":"2.3.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9d201a1d5d6462bcc486b7c21fdf04c7388a40ce","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.3.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-+Do3GHL4tKuaDreJfrghObK+uRvDG8JzGb65mi+jH8gUyqSaG1uHvPlsM+bsTfB7WydWHjbZiwS4zi89rujquw==","shasum":"0a12acb0ffcb1764b310a7ef5c0a42c964ce391f","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.3.0.tgz","fileCount":66,"unpackedSize":1557473,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfyiQmCRA9TVsSAnZWagAAsnwQAKQKSg7+Le171fB9o9qY\noBSeejyInJnNeZlsOrAySvQTzux0o3loCOnZHjAkdimDA+BnzjX6Nmr3Wg9N\nVa5qwCpV3HW1Q22VrW+3kt8VNE/Hct5T8jpXLvMNeffz2DqDCbLbVSYPQHGa\negSwMM1xzxy6yYCBDrumBHjM9TkRMa5g41uKFb2LX3Efc89E7S4CG/eD2wEC\nzhKOuF2ULEDWoyeOIxGiilIcMnWl203RdP33cdOP4nK/OUnyMI95rgYnEHf8\nUcHujOF+q390ka3FSLTa39ObVHhzQUolHNZndJCRcNtvEupDPrdy2JZljxyB\nZX9aYUbrz8jYhGuAcTgBDQ8jHb7/DgG1qwPBUkrQ1BMRnFRRFyVwX78AVR5D\nNAzZAM+iSOym580dkovhWOAP4UKbF4NudbIknIC1LNOkNCi8oROEXb+y3kue\n1UH4YAasWOb4X5RgLzoia/1uVQ+k0fbZ1oi3tAwy8iDsGxyawD38FPymlakV\nK2IHwmkbxmEGVADcXeeT8+ki+e35Sjp9crHiHs0es0jehl2prVr+aopSLr6U\nwNYhORVAUogmnleuSz3z9FOyYrYABQuyBa24TtBEDW0gJ5JRb7e7Lh+5Hji5\n2C6TvxAweettiWLHVqo/i4FwvXGEqYmJ3h0Q+J5AtJku8s/e3pV4FSN8cXTL\nVX5K\r\n=Hu2p\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCovkaqg7Hf0FbqmOsZ6X/sNhuopqHmjJzCJ8zOjIQL4wIgUhMWYXQpkF4jfmECXl9OjYs/vXRkGq3mGBi1lPAEvPY="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.3.0_1607083045891_0.7154397982585865"},"_hasShrinkwrap":false},"2.4.0-canary.66.c7b2b744b76765d7f12017a5b2ee7da64042847b.0":{"name":"@sberdevices/assistant-client","version":"2.4.0-canary.66.c7b2b744b76765d7f12017a5b2ee7da64042847b.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c7b2b744b76765d7f12017a5b2ee7da64042847b","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.4.0-canary.66.c7b2b744b76765d7f12017a5b2ee7da64042847b.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-E/8vh/7JMnoQHQaADC2ZbeNtEAKXpEI9VfVRxNB2xRq+oKPpS1fbaz3jKHNIkAwA/Kassa9fAFYOGPod1VuA8Q==","shasum":"bfe041f946310d6302937520197c303a7e3e2e42","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.4.0-canary.66.c7b2b744b76765d7f12017a5b2ee7da64042847b.0.tgz","fileCount":69,"unpackedSize":1563974,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0Lv9CRA9TVsSAnZWagAAIX8QAJorXp2ajeRs25/Jsrwz\nHxft0xbp+24PkdjEyS7O/zeq41ceo0G2uXJ8NTj5RLwsOZ/WD0jjNW/IMc+k\n86SxhwSl3EqmYhJq0znD/PcRQ06vMvk8QrIFUcl7x5LRhpNqD2Pyj7F8zxYp\nP3gYI8kOj+JDbpapwyyUdwn8ihyBnJl6Pc4YFxT4sAwwEdd+XjcvJK3FyeIs\nTiBxUeKM+M8jTH068pnJ9H1IkPpqLAGZ1xQDcX8hxoY0yogfO+F893c5lnfJ\nA3xKE2IpBzgqbFTKD57i/+F+AeSnr77QVpOOJOm+at5VzLffxpvlH6tR5qyo\nxPY5Y61XTkNcV5tqy9xGDbH4DmKXPR2Qikefi8z3N/dyRVPcLhQMU87OjhzG\nM6bJ1cpBcnNr65gsTeq0sbGsEUk43GaYxVq20z9zL9beomjWPmxk4Ln8M6Up\n5CTsDwri0mViTV/kQEK54w+a39bWFZEXrNwcOBHp4KraX+CZN6lbFPgCdISZ\nVZnHP17EncQaN/TtAhteS5/O0KAufqRiYtDfzZbyyIAM89jw0ZuT6Af/TOVs\n/92LfBR4YvMxqh20vRmHf3nNJusisL4Kch4tjJUEdMhTN0WNaTcS2I0o3NEg\nZUEQdMAj25fUG1PqTBeaL9Te7KdnCbCq/DcF58DWoN9D4V+GYNUM8iQ6YlIE\n2k9A\r\n=opsn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDIUdOa/wIGIzaRLH3FI4vJms+HskIo74b8xFUKvbGByAIhAKB83QNhM1I28kp59jRQCijialYRMT5AX6gamueyeopx"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.4.0-canary.66.c7b2b744b76765d7f12017a5b2ee7da64042847b.0_1607515133065_0.5555098443356157"},"_hasShrinkwrap":false},"2.4.0-canary.66.9cbe72cae1f80086cd3a63695f4056250fffe5f2.0":{"name":"@sberdevices/assistant-client","version":"2.4.0-canary.66.9cbe72cae1f80086cd3a63695f4056250fffe5f2.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9cbe72cae1f80086cd3a63695f4056250fffe5f2","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.4.0-canary.66.9cbe72cae1f80086cd3a63695f4056250fffe5f2.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-nLo3oJpQnRRdkr4jjeLKe4j47Slb3CGArpRnulr5G7/z4fqeXbz6HxjvlS9fPw0fZnrY2241UUYi+HUiYuEbmg==","shasum":"1c68f199cc739999d6c1be8b5cd9e869bb17d19e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.4.0-canary.66.9cbe72cae1f80086cd3a63695f4056250fffe5f2.0.tgz","fileCount":69,"unpackedSize":1563974,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0L+bCRA9TVsSAnZWagAAOUkP/3zG4mSdvmLRrAZTVjUn\nLpyvKSuNFY9FSoOJJiL2jqelFRCb9lEvm+7d1HpvxFDHWhIv6xVzNBuBStGx\nZimPNPb4euXpbmu1RmGgJEAU1TVs/fhawgsvAzrjY1wpz5kWJJFnYCr8yhEe\n/DJmzwsrNikQnQ7LJi0I9wbWmmPxIjycYXjjt0o+KfiFHBi/HWT09hsyvASS\nwJNT3AmHduPfPFw8nnIuyT7RzHlB0t2JStU0D1b3fIl2/+vJLPUOiiMribNd\n7qXnNooVsh2Zkhh2pkFBvfpZ3D0LwoFDH7TZlSQd8xm43jrQmUtj0JTOUW1a\nTSQiAVGr3cp760knPjrHXwJyzVzwAdJfojydhCvNVUWFhfEzI/Dk0lFCSsiM\nK7lXq36PbrHIM6RF4JvY+Cae2oDGMk6QxfOrUOC+wwdlxqoHrFVubCAaLp32\n+a/d+/e3UEJI0Na7+l3+2sFDocRra6i816yYdc9PLCUbQSjnKbsXIEsELX2A\njyWwXAjLlXB33qmGQsilpU48D1TGVwh5gB6rByKet3+JVKALfvGkJCSvuWAo\nYpYf1jmZTMeJz045gDlLXJx8mDC+WAEBV8k8Dl6Ha56jpX20xgIZke7B8t8q\nZ3GE9Y28xFCS2jFO1PHyBU6P+SuAmChObXCnfaXFgx8fs43AYFeoc5lF6pGG\n8KGs\r\n=xYCM\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDOoHuxsquDWqKjT6JSo5y5cwb18gWVnFPFuPGAUY7ThQIhANm25/nWzA9k9tw8/ohuN0XAYsFwJ5Op2jM+cl09+RbW"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.4.0-canary.66.9cbe72cae1f80086cd3a63695f4056250fffe5f2.0_1607516058661_0.18097950409377916"},"_hasShrinkwrap":false},"2.4.0":{"name":"@sberdevices/assistant-client","version":"2.4.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"8e2d395b97064da0e1f074f3f3d4bab1b1f0fff6","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.4.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-YgnCVcn2iS/UGdkCxz/7VfHQag8WYxYuQY9UC8Jj3Sx824kBF2Dl54IFeeEZqAoL+0dqfu5oX6oZbvyIiFT2qg==","shasum":"1f83fecbdd70562c4348a5ad9f11bb9179a47f5d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.4.0.tgz","fileCount":69,"unpackedSize":1564789,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0MEJCRA9TVsSAnZWagAAk1gP/A0BsVRJQy1zE+4oVtKr\nJKHoYarIMipLNuhJJ7U0nNStYb0xGe3+I7czbYOPp+FhxtTcW899uZQytwnv\noFiGHUlCMyP/mTSXEKbZpw+sX8s0I/6HjvXfnO775+RbNwNHAdlq6wgvZ8BV\nGcd6yZTwyue8h6VMdh/sRezilDrauT1u3wZjgn7QvceuBNYB93LAOuPXCiKt\n4FgZGY2rkdQf+jFpAk2oZApTbYxxUZVvfyGTLL97+fUGmsVGqky2URUJD/9b\nT5iryfacl/tzHIXSpm6WLgc0vlwBAC/gNs+PX795xBhq3TjGxLspVpTw8r9s\nTJaNtERz1d+OlSG6VFEcaj2XQtcXfXyNL54qw3UIWjGyX8x4EkSgXtAbHqE8\nZwqXD/yLDO+whHco1MVyJqQ0roWGv9Ew73Hnpe0LKvHm9y26bFRHOwLN7H0H\nAdOCmGynduvxUlCSCdLTRxdXEEwosMUo/4tjWBBMCMSa21edzd1gJudhBIha\n+A+xG6r6eoSjApcGV5732bcEeTwCku2VRMku7Da/caT5FqtE3O5oivkylHpb\nq7qDQLNG+xJOVjdqAhHhVFI7nHDdXwYIcPtQ8eUvG2sl4TEdhJ1Bt4NAlRs4\nwMiOuKzCqVz0iNlae+8dKwt1yTUpjpNJZVKtbX5VdeGzufiOi8Zf8QhsJT0n\nyjfp\r\n=pepU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDZJlbll8ItvsQO2ziqXrURRVPXvdYAIlyt6Pn9piewxgIgH8AwNVHhptYjNgtHsIz7Du/kS5gkFJdQQ4/IcJ6cQiU="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.4.0_1607516424684_0.5964478174515653"},"_hasShrinkwrap":false},"2.4.1-canary.68.9c1e7e987e4fed8d01f7b732e1e738ebe8cd252d.0":{"name":"@sberdevices/assistant-client","version":"2.4.1-canary.68.9c1e7e987e4fed8d01f7b732e1e738ebe8cd252d.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9c1e7e987e4fed8d01f7b732e1e738ebe8cd252d","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.4.1-canary.68.9c1e7e987e4fed8d01f7b732e1e738ebe8cd252d.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-zthj3Qhz5b2azR16Hh9yvR7BUb4GZY6UVUE7vpMeCYa3RyuBD6qMHJCjwdWPXwdTvwIYWQjyAMBm38vUkqLakQ==","shasum":"92ee51f6fb832051bc66334f3c295eba6d162634","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.4.1-canary.68.9c1e7e987e4fed8d01f7b732e1e738ebe8cd252d.0.tgz","fileCount":69,"unpackedSize":1565021,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf03YoCRA9TVsSAnZWagAAF0kQAJTg38g/3XpwO5B/xblU\nWqekjWkJCJ+JXvQtgp/o26m3taFVLPZXbibaiIZCeNhmuW5XrpsdUO6k6iF/\npEikS35dtYp1tw52QGXzJYmrToN3/4sYWtdbTtHiYnXaliCHyYZl6LOa3+oA\ncQpkJXgjLs9sC7ncjOyAgUOdKbJE7mDupKAWd4ma3ak3V23Gm5L3IvepWIrd\nV0MaDJrq870h3lvABvaNK9pmDQn/RlL34KOZ0Gh4N3q9s0eNfREBkPioM4/V\nNJ6zILzerJLZOW4sJpfOBwoi6WpmNnpjp1m8/W2aSB/DYv9yeQ4rY4OhAsOp\njjhevLAJe59Dz4rLJQVsGXX97Wc5N1H/MPkJw9w7c75twGv1TyVVQoHM8Oh0\n64JHlm16cQ2eod6Iy5fodgd92ynW/aZDfBe5cmY7Z4tTbAPDe/3Q+BeeYghy\nNupaWNqPWMzUmyJXCXcJfVAwb26CJwEGdIt+6eCWyoD1XjgHfjMZKOH/3+QG\nqFw8kJMqfPuj+F0Ulzb1+mWKaZEkhqQ6rFvY0I1szXzjY38mKitGWXTLI0t4\nrXNJ1qwgK/w7FDMdcF0YNI+y7AwOBW8n8VMPFzquroW+WzMJjLlzY7bDD2E3\n0tdD12TkVIcgf0KxASqs2EO+JJS3rhKearwIY99wTYbqMyUCiNt2oQyaSbhq\nCMfC\r\n=WHG4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG7noO9je2vfbexX/d4GGMICyuV4T21evGQZ7X8QY0r3AiBFXa/2PRxblpoJJxwynD97AVs0EiHyO2Yqp3j9xe9O+A=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"awinogradov","email":"winogradovaa@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.4.1-canary.68.9c1e7e987e4fed8d01f7b732e1e738ebe8cd252d.0_1607693863248_0.19875211526185943"},"_hasShrinkwrap":false},"2.4.1":{"name":"@sberdevices/assistant-client","version":"2.4.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9f15b64330033a8fe5fe149f94dd714a6d26093a","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.4.1","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-UdbGGKFAxpGdhbhWPoE1q23YYeyYRHKp0Zgxh5OVJhexUOYiweSXVpUr1+ecj6oJAAmiKhZybpTSlv4FPB5i9A==","shasum":"1fdb08f49f189c0e9f38a4d9ac6cc0903781c6f5","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.4.1.tgz","fileCount":69,"unpackedSize":1565434,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf2H4gCRA9TVsSAnZWagAA33MP/168sn4povwH2g0pAdF4\nT/SzJ36L5+yKq7HZqUcaz+YNZylCwyDJFr1nK2hFZvmD/HAjWPf9Ge3IVFvH\nWOLrZW65OwNyX/MFibHCavppWN71p5+HF/n51IkYLjeEkPw5hAyzBRHMfpJH\nEjCQ0iOChINF6OXvvxChyI2h1b/MDOb4uRv5IssCQiIsYCJBwn30PCDH0+iw\nQcKgLJgt6cwbuOlyePd16I2vZMrwObGwO+tUxq7Z7pgIuqVxHGkqmBUoC3Ac\nkNOElg816JS+7wGUk2RfgV7czElkd6FjfOA0kTMZW+GwEQ30Jv8LfRC9ZMby\n72q0k5myecLale6s4Elhf01PWdeRsRPLpczS2ywiNADyNpc6bT1h97QBTS5U\nQ2wPB1UK72v8jH5+bjgxNFDBpajC3w1aFVItXEQZGjVCsoE0CG/BL7yAUH9O\nq6xR1P4AoyS+mjeeQyjHZdT7KKjwWt1I425lZUKfky0UaKYumDOcbO3APHAC\nrCgJnfZwiQ1BpXQAwMJPUWcaKau8eSAlZeFfsDDggFo90gLMlqt0LiMB2F+l\nBDTT1M4tJE4KpFaZ8Nk4ecY4TxIYNdcyns11IJy+JVbqACueOZxlTaVnnHoJ\n6R0hJRl8oyx0BcN/erF31ubZPgBwpFbsmIal4UEvfMQlLx2JGaDRk0YVnD0S\n0rcO\r\n=AETx\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDNFc98G4PQ3btz8LANALc/JdESlXtD2MTPFO0HLZqnrAIgZ2Et2CWYERRjVqbujiwdT6nx8t+2smhtLDr+QabQeUs="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.4.1_1608023584100_0.2513211255863632"},"_hasShrinkwrap":false},"2.5.0-canary.69.cbe3992c562bc2071f2b1247aa88c74fa1039f10.0":{"name":"@sberdevices/assistant-client","version":"2.5.0-canary.69.cbe3992c562bc2071f2b1247aa88c74fa1039f10.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"cbe3992c562bc2071f2b1247aa88c74fa1039f10","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.5.0-canary.69.cbe3992c562bc2071f2b1247aa88c74fa1039f10.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-9yVHu7QX6Utx/eFt1+kn2JlX7J2eYJC8/vr5vlz81KIIH6/OaOXj+rX62BkCl+YelXZSEI00vsGng3ttyMG7Yw==","shasum":"5461b629305c27d04e970282983704ba1297d6fe","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.5.0-canary.69.cbe3992c562bc2071f2b1247aa88c74fa1039f10.0.tgz","fileCount":69,"unpackedSize":1572701,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf2IxeCRA9TVsSAnZWagAAJsoP/1hsf3kVDEIqfNJjBmbv\nOkWdA6r3trLdpWaBRwthJ/H1C3TdzKiILjKLAlme616itye3kksLU18+sczX\nrw0+L9KzVOnEeMxOM5lmSOAVYJvnZ9oZnS9n5ChdSFjxWFYVcE61QWwq9kQM\ntOC9tYeVvCaOpUaXg0VJ1Nu0wb66GzwwFGah82R+2av2X9OQF30REe0f+9os\naS7C++7Rn15e4wynNFi8X8okoGUouDqT9lfzDb7tjgpNkbuOKdsWCM+tMRab\noNoUG/jWXYGiptH9GySiQB3D2acfhUJpjAmCXLQl8cyio8tzdzIjDJQSPgdv\nSQ3P08aukWFNrjnUduRDEcDEDB80W/3iKSOkgbz0u3UHu80qvsgvK6GPaJy3\n3AXWVxKHdFVzBqaisxq/ARAKfbZRWBM9fGgrn8JcOHza2lKGsd2uyYlMO2d+\npXKCVO9+beld/UFC+YhEPKw9brJaTFVm8SG5UZ75hvaQL+Bi5KLJyZHfDQx0\npJ72t1hNJjWOlfNwjLg5H50zH+onq2PBvdo/fW6V12j3R9odEMpebFciNzNL\nftmlEvxB52YqOIjNzYVhBadKTletqQZxorzbBQRL6AeqkTc7NMNHnqKvpAMc\nu2/4G7wWclLMKMJHoRsDN3IxWVnm30+FJZ2saa9e0Te/nyPhhPOl99+EMXP9\nSasQ\r\n=MYQB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCI3cnRGibjbFVLjeBCMLHtnw1iIjNgoh5Iqhqf5E0mZQIhAKZyYYgf/zTzbWT69NKZmhChHJ8UFeywJlQrHkvpJ61D"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.5.0-canary.69.cbe3992c562bc2071f2b1247aa88c74fa1039f10.0_1608027229699_0.59370804726809"},"_hasShrinkwrap":false},"2.4.2-canary.72.f61261ca3bfc7f81c3b27a66b52c2fabd0b6b1c1.0":{"name":"@sberdevices/assistant-client","version":"2.4.2-canary.72.f61261ca3bfc7f81c3b27a66b52c2fabd0b6b1c1.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"f61261ca3bfc7f81c3b27a66b52c2fabd0b6b1c1","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.4.2-canary.72.f61261ca3bfc7f81c3b27a66b52c2fabd0b6b1c1.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-xqvXocNGZLletwFAtHDC24Eu1Z9Bcu+lB8IpVhIbAjoHiQVgKHZu6ZRbl34JZw1ZcdtnOMS3waG4o19JzXl1gQ==","shasum":"98785cb98da0b0b642ed0731d0b4fcedfdf2252c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.4.2-canary.72.f61261ca3bfc7f81c3b27a66b52c2fabd0b6b1c1.0.tgz","fileCount":69,"unpackedSize":1572864,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3KchCRA9TVsSAnZWagAAuG4P/3SsYszo1yRXYloia0Q9\nLiCqa1YwDkQ8GlHqbYsrz4pEsR4vaA4ir4vN0ohGPPJzeqpephiozxSavwjV\n9FkEH4JXd37WOyVI0tAjIL0EpIQmomLxKMsqRdngkgipSQOd3+KxY3pQb3/k\njmkmDZgfElb2mquwvFYx9IyyX/EzTEWgjmDWwJmltqJGZhNvfGs9w2xupkdY\nEPegOU/yMhR0b3izbMRekZARRXs31MkPFAkstFgjNXwiN7SwfPgXV0QtaUCu\nFTTqbgAhWPULckJsO3WcG8716mdACC8sIU4KgmRdaAM8/P9DYP7rKMThlEly\nT9c9MP/B5WwOauOgO+IvJVkAx7f5Sa1qMLnlII25OQMgnBxwSluXw7jM4Vnj\ngcCgDjnZrIcWlr417zEalVbrAk9NH/hgvedLd9mgWuf9irSTENimh++Ffn/2\nz+4IkgCgM6Bc/T9PlAhW39IA/d3IwyFl8Nx5dc3i62BWQZIMy01TCXStnOKM\nZwhYMJlG9OQr/+47T4cSisO4L2DD74V95ljslH4ieh5SG3XxRBObWGvVayTp\nETlLxjJMJ4C0kaRR8RP6EimjElZVYI/TO8SHZHfyy27liS0BxqFETf1YW7f/\nHHMdm19bZt37KVaffsWi01eDydebt/yhRHuJYAeJ95WOy4z/F6Ekyt528kJy\nfLfH\r\n=VBuU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHT8wXp89mtz0THrPSFpsD7brM4XLRN7gYtrhp4omGawAiBhF8aF7cIw+QvZPOK3I1u35tkQGmaFifqRUKnJwecSwA=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.4.2-canary.72.f61261ca3bfc7f81c3b27a66b52c2fabd0b6b1c1.0_1608296225427_0.27614904624459236"},"_hasShrinkwrap":false},"2.5.0":{"name":"@sberdevices/assistant-client","version":"2.5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"1f6133c678c21b4a06ca402e67515dffd21dab4c","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.5.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-sjd+nBAIA0S73SGDBrQ7V4Op++Ba0IN8Owczzb4c/lCfevGScZwEr/ff7ZabBt3k9n5gPtF8y42HCjxpE3R/cQ==","shasum":"b261b9a64f4c258bb609145afa3091fd2226e50e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.5.0.tgz","fileCount":69,"unpackedSize":1573939,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3Ko0CRA9TVsSAnZWagAAPpoP/0bxUDpeKwzKkMiEyiGF\nVvL/teG999R8FXkVm+wTvnBNWhfg204225JVPTlw2D4P9QmWH2OgXImAnHX1\nmxJNOJ36VaKUfMSAvLp82xmzgUqdaCzBhy/5xyH9J/NOOFQAEJAtCz8kVZyM\nwerOJCtdB3xoy0GuWLXu4h45ZNvg+PVXV9lEAcH8yz0jYjuHdBcOyz945A3V\nPzdPB1Q/IJGsOWdd+44Is4byHprJ8fJ+5+Cs1LtyAGT9mMtlj/niiOL3GAmD\n2ClIlyEVSIwnatq9g+p04Oop52pcTwfddHUeOY+TjXe6L7U1MDNAxHRRaF0R\nXloNSsxUyXO/V776uUZonad2jRP9WXsfZaXBYsocwfTGcs5t57sI4wPmFE5T\nnBWbCKYavYDc7RsX01VHNjHCEbElXudVPV+6QS6z+cWdZAL2uETsZcF21JFk\nojTiMvvj1cTHSCBYH1hCEfrF7oNe7oOaJP5qSZdceCFpzXkrem8KJeIDcqFZ\no60at3pRY3XalrRf2XPBxEeIH2kBZFclOu4ONJm+czYz540pUJ2wsXiWsp11\n1RqdIijc/ODndatgw2rK9Jt6XROjPV2yixZPtu4lns+8CnbwFjFo4EI0Kqhv\nEFSwOroiw+u9Z0ZFf+Mcd+KradJk6zl9wJaNbWqMeEtQoZln9cr2jNHE2J8I\n/1Wh\r\n=/cUm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGPWrdS1obx5PDd6lczZkoUA8tKIZ6gfGY1IA/hwqK7PAiEA5s6UWVL4s5sJTiDldtU7+ny7b1tU23ZQVZlmhsxz7KM="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.5.0_1608297012135_0.011422657844964546"},"_hasShrinkwrap":false},"2.6.0-canary.73.5f3fe2717895d24dd7b02404eab6d6b4948ccf33.0":{"name":"@sberdevices/assistant-client","version":"2.6.0-canary.73.5f3fe2717895d24dd7b02404eab6d6b4948ccf33.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"5f3fe2717895d24dd7b02404eab6d6b4948ccf33","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.6.0-canary.73.5f3fe2717895d24dd7b02404eab6d6b4948ccf33.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-U7AH+Omup/XiXlcGlGslYuOH7VghuOal2UZgVVVoptSVnE5tymbnAsReNLUlsIT4zxmuDcVCuLs4p7gfE4g4ww==","shasum":"65847cf5943f46eaa4f08e143a1dbb13f38db7f6","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.6.0-canary.73.5f3fe2717895d24dd7b02404eab6d6b4948ccf33.0.tgz","fileCount":69,"unpackedSize":1574644,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4ffrCRA9TVsSAnZWagAAYVoQAJkP3soHiMFKamb6jgGn\nQGDJ3TTqJobW/le6Q1tfFRt0Ey/Y21v2rXgIg9fV1XaJ2I9AvzA76ziZu4xh\nB6cUPLEUfLSSxRp+D7vgPTOS0zSmT3SwnpHv9rCO8nVP0B0v8RoL+mn8ArCe\no2+OQc0Lwy9NetwUXwiE8ERv6y2JZ7uv6+l3JQJPNOjEpHFp6w76ClSwatxY\n7qd6bC4J2D77U6xIjvVKHv4FHC7TVJLodbdC0Rx5IoPMSd9pBZkRA59weZUO\nMJULSKS7OiAbbpB6wXSD1rP+S7B10swFFi3YaRuyacfhybvScvSRaMi2vL9M\nrBPst3Rr88RgcK7C4Zl8NAmxIdtLlhNO1T9C6h9Bu4blk9iiK2a4HKfinLQt\nJQ6nrFZKvUw3AuOAfWMAvpe48RA3hIkLjLG7a+PePpll7fknDxmGlbiPriae\nP9oemm/w+2sNaSm/YxMZbvNlc0keHym9QgEUa9AD1grPTXxSn4aafj7j5fKf\nIoqRYAvU6es8eMiaYQLHAZ8y7/0fxvA0wnUVZzYO9ZkvtlYH7cMoUXxcy5s8\n4BKZWk2YVFkAmZqDKTTPlhMUfM48UMjK0xCl8PeB9jaUvPOvQnbXGKvt2GPe\npuiywkBHZbV6FLy989loMvTnd+il+NgEoKHNYE2Ndo6lywR9xtJvaJ4Io80R\nmwjV\r\n=yKOH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIElXjG0dnGbdrW8gIaEgMgHT4bJWWfxCrPgTV1kQdA6/AiEA0x5gZNddJDGCZCBpn4x5rxTc3A1spxv2qz9WXyZOZUg="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.6.0-canary.73.5f3fe2717895d24dd7b02404eab6d6b4948ccf33.0_1608644586547_0.8096947156256511"},"_hasShrinkwrap":false},"2.6.0-canary.73.32a4e319535a88e140d62f8431916719eee4f971.0":{"name":"@sberdevices/assistant-client","version":"2.6.0-canary.73.32a4e319535a88e140d62f8431916719eee4f971.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"32a4e319535a88e140d62f8431916719eee4f971","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.6.0-canary.73.32a4e319535a88e140d62f8431916719eee4f971.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-tuFm9w05CGYR31honExU+7h2KSnlPhCfJi0DrUxtscyjTlDDlYCLY8Iqung6XyvDlGJjSSEQXo/JiK9PvKsJZg==","shasum":"196beaa515141f59958aa8f2bc1eeaf5810d76bc","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.6.0-canary.73.32a4e319535a88e140d62f8431916719eee4f971.0.tgz","fileCount":69,"unpackedSize":1574774,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4umPCRA9TVsSAnZWagAAhBAQAJLkdNJnuQAikXLjILLt\ndUjBEDwQZgHgO2DaKz5VhB1y7y/lp8y5DBGcWa3UtCRqSPsS8Waj5cO/e5GO\nrpmb9GglR6LgJkKsh0RTuwbNf4fnTThRMgWtWt2Z9PWrElHdSiwAG+zYr2b+\ne1fLX6dUdrqUPf7iF9m59Yg5oQuXsavpPAQzd37ngscGLOlo6KwQZHtq5Rfn\nfnxjdF20E1n+G9VnT16xQFJDmszK+jWWP+qoQyRzI7bXY//xx5p8doyuhpy4\n/Kzg7WaaYZSUDzT982zeZ3hinL6u78EMw4Df3cnIzFSGtXqZse+l8wTkdcZy\nk3F6hW4JM0BRhBTskPA9hok15n/POfhB50PrNfS1OGUxeTBy/vlSRUFRkPnG\nyzCTH8jSShzbIxiKXQDicTjjp0EpBt/w2VyzNEzrMDeeZhUEfaVgJcQES5/J\ngsAlvSvy1GYZ5ZI6ZIbEz6jPc2vmaxp8xwotxR2/OTjBk5i39BpLeeGnd1hj\nl+HCkpxyeCx5juSwEoG7dYTB60TiAZt9uSRHaeWoq2VZ+vRU3b1crtfgOVl/\ngnAh5uFcdgeovJO3l4nUW8JQwBlG7b2+byfmC4VaSOZyGI4MqqpLaeuvJHyV\nDvqZyMkbtSm5aDpo7+c6tQHSOUM/7Qa/9BKflGL3D9yP67C538j8eng79Mym\niPGZ\r\n=X+0w\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGrrrTOcC2UgWVDV1vOymAdt4OXXIwBZW3MIpGGLEICUAiB3l88aprA2MR3hXrNVckKIbP982bmMOrRGcw6DC7/nAw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.6.0-canary.73.32a4e319535a88e140d62f8431916719eee4f971.0_1608706446523_0.5705473074169436"},"_hasShrinkwrap":false},"2.6.0":{"name":"@sberdevices/assistant-client","version":"2.6.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"cf31812ef814eed9e0a9afa1a19b096b8025048f","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.6.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-V6iGdomV/pZyaxphF5OgMbdbBSxxbqL19op0c6N2QMrsvlpGd/eVys5txKBwixQqozYaKhmqvkwIkdvdsLr6kw==","shasum":"d8daae3a9484750ceddedf6078c8cbd3cf3fac9d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.6.0.tgz","fileCount":69,"unpackedSize":1575021,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf4w06CRA9TVsSAnZWagAAHjIP/jrtQxmbeVewvvDBu5wc\nJSxnB7AfLIBAfQXXi7Hg8PLRcwfEtjmejS9cP61ZQA/e30kKUZeI7tHw4e9z\nA76GVYGH1Yd/7IyC0K9Q5rZGbJGeeu4V1bVGlCgHhCr0aGPD8+0LsQNccHy3\nkrr74ITK8bMs/Pok3OpppqSW/et2eHqOvmyYm5pswHbA1ANiBGDsg06j44/I\nGQs4aeZsB2A6v3GXR9jWezyVBKJ3rZOZYOOl/9X4c3lHu4Ea8HEZBICPDlXa\nEzp+TTRvmceIbVAAxwnhJKRCb2JIdCmWkW7OIA76iZ2VZVqXWyxRkGAAebX9\nPK954xxEcHFj96p8ldRiJjHzJQauTXC/b4+JRt3/cCvxCWDbwT+ixtQod6kq\nBH1ddhkFpoOPnGJ1zpVaA/doCGzyMdWZiefbMICfFuRI2WGWCtz9FLMectoT\nibOG/ognl8ThGHKjVX12se9lFAxgG3GQF8R4DXlNo9ckgSK7qGiYujZzsliX\nlCvklVtHPsfFywYu7OYdffPK5QBAQjac2psjsdwBLTDWVo0GYtLp9uzWxDhU\nKYUKpry4ZjrBrr8zgxwXk0Ij9tONuM0Yg5qZMuNVq0qAyn5YtquBwUYobeIq\nT6p8zTenNx6WAOO8TiITIPQ4oo4zYA8PGTgSy85Lt0jOSTvT+6/dIZ2TqbAn\nnd5f\r\n=0g4e\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDACfF5pQOLuFo9kWL3h18MQTqdj5aMJnvW4+XgejfhHAiB+vgBcqMaNlFs8Xya9apHDSPher/yztueESL3Ydqzm2w=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.6.0_1608715578277_0.0918202249975264"},"_hasShrinkwrap":false},"2.7.0-canary.74.d8f42e3013406e708ea6c932439aa79a9e5b1ba8.0":{"name":"@sberdevices/assistant-client","version":"2.7.0-canary.74.d8f42e3013406e708ea6c932439aa79a9e5b1ba8.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"d8f42e3013406e708ea6c932439aa79a9e5b1ba8","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.7.0-canary.74.d8f42e3013406e708ea6c932439aa79a9e5b1ba8.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-uvJCdJVg9Kc7N0hpCzTTPp2dCLb1q26qmlUJvSv8cWTRAByITmVd0/m++LlYuq79kRm0IZMVo2f20gm9XWBXFA==","shasum":"078dd7386f4e01ff4eb5fd2bc3ff8f771e318ea4","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.7.0-canary.74.d8f42e3013406e708ea6c932439aa79a9e5b1ba8.0.tgz","fileCount":69,"unpackedSize":1580350,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf6w2pCRA9TVsSAnZWagAAwhwP/iYL1X2RCEEiiee4qijC\nfCC361a9K3Zz3StXpkA7htFhB59XKIYfSQKxSu4zEigX5FLzzKa+UPKcnv5z\n+N4Kn8n2Tu21ghj1IcOj/iZonR68fotk2pUbPwDWeEZ7gX6euyB9Uh4FPYVu\ng1fM5HToIYfsstd3yiVAWpsRLoUXXZlAKkJlcPikUJA2Ct1IZF9Tp3ipTKwA\nWXxmGqm5gjRQ3Ih6+jNBW0mKSfR12Dl3RTQqeK6mw00id5m85gAVRU2EXyX6\nWnNVqyjAW8woxyxFdwbFdeVDByVuMFj1zD9lK5+PXUd5GI8S1pWRjDmLVO0T\n2HYFRFPlCZPuAnAuBNYtXSM5FafvMzh3wAOT9GB5fBd0M38F7K6HI92uAteJ\nE0B3P9wbE2OklWFVzWGKXVkaz2ZpReL9QeUWr4thwr7mPoM11qu933ciimqn\nxkrY1i8Cp+mrEpqZCJCY+6wsidnV0iNnzIUAocNv0u4QJz5+je3aPo8S4+jN\nowkPep9XDkbKfMNaLayJ2biV2EU+tt9NVgWk+Wy7Ivw25U/wWz4iQr/iDf5G\n0y7oyPfpv6DcVfmwdqOxpGhczirUwoz88V7XqZR75glv0+rkRZLMALcjsna+\nOWtMi0V5knRiyrNTIDlAD9hwluer+WFVAk0C+6E3TaO3nVT0+8MSXXMDscix\n10Zu\r\n=UjRJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDK8J3fZMsQ0/8NVaf3K/Pc3o7EUWu7YnVC+ihfEezD6wIhALZJwPi42x2qFvCXX5IUqKuN99rOZRbD+Oav+KYdEjYA"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.7.0-canary.74.d8f42e3013406e708ea6c932439aa79a9e5b1ba8.0_1609239976588_0.9909636670775226"},"_hasShrinkwrap":false},"2.7.0-canary.74.26d827d71d0af7142af7cfecc7d2a44d385cdb15.0":{"name":"@sberdevices/assistant-client","version":"2.7.0-canary.74.26d827d71d0af7142af7cfecc7d2a44d385cdb15.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"26d827d71d0af7142af7cfecc7d2a44d385cdb15","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.7.0-canary.74.26d827d71d0af7142af7cfecc7d2a44d385cdb15.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-RjOXRcthds30+QbIJ/Vunz7+CL1f9Tgt7Osy8ud2jkC9EW5fT9tw1FxdqtGqAqN4TrwdKkKz4wN5jKZL2ilU5g==","shasum":"1b93a05f5502f99a8d7b8d84ce0d39593eb6bb7a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.7.0-canary.74.26d827d71d0af7142af7cfecc7d2a44d385cdb15.0.tgz","fileCount":69,"unpackedSize":1579166,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgDpQfCRA9TVsSAnZWagAAwpIQAJ9HMmEX0RVantMYzMvX\n9MNCgzLS5LDA3FsEztN3HvQQB0+RdXqsfQ1P9o7KPN6QfYG7bf03uS1rywR8\nqntHOG4KVAK8eWlQIie0qpI4Kxw3/Pf2AmSW8EncMOuBgTeuDZddi7MULF2n\nt9W0GYkNDFxGw0Oy2PZfp1aUPp77xaHYQVmUg/3+ijdeDrX3wqicOBQjrf8X\nJ5aZ4dsEbTmzRf80caWSQvdgVzROKyWljGIz13ev/27wfLba813PtPRN6v6c\nCiU9ptCMySuv07/5XxdMdxwHQrJDHvmB/AixTQD7v6CIHRIxf7EDYtLwKvb0\nYYRkVihS1CgHBJvFLOW8aehdYuCaCiDnazHIXvzQlLb74k6FHO8d/m+z1LXD\nQ5EsOe7U3+PVqO/y7+DqrDjxCKKsDPULU6oFum6TyVI/b+IOza8nE6niaHTH\nopXQcs80ZIucOpUj//3hNXDfVDDVcOZ0qGprsPb0nQiGsshQTIFLC7dcG3ca\nPu1VRNTCQlguYXmhGP3x7i3uDO+E1mkPV544TMeEe8TzU6NNSw7KSoWxtjMG\nXA1hxeJ+xp9ph4x9AunW/TjEeWNqLjHBMYc4OhxHc8tzgYGttasEoDFx1mTS\nh1r2GR3DKR6RJt/7fQ53/dTl7pWsA7ABcgG+iiFE840bkg5hl/D4N7JLy1n3\nwX2n\r\n=v5Ev\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFQa4wCHJpse0kdc3MuGOyNzYRGmIvahDrt5nz3lD2hbAiEA7VIpyeHBetlys/hbk/sVwCI5rKXBfR6ZVxhXp3Y8gJ4="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.7.0-canary.74.26d827d71d0af7142af7cfecc7d2a44d385cdb15.0_1611568159032_0.34102017340669866"},"_hasShrinkwrap":false},"2.7.0-canary.74.c934e4283921c6cd31fa3d2a153b5d9f8f49bb0c.0":{"name":"@sberdevices/assistant-client","version":"2.7.0-canary.74.c934e4283921c6cd31fa3d2a153b5d9f8f49bb0c.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c934e4283921c6cd31fa3d2a153b5d9f8f49bb0c","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.7.0-canary.74.c934e4283921c6cd31fa3d2a153b5d9f8f49bb0c.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-wFlWnSoZn23Zk2I4LGvuuZxQRMCzXvkjcERAqe40gOJ71qgLQ+r0L3MVmJSy7luC/+CpmWuKqdR9ZgrVht59CQ==","shasum":"21aa88b081316e61835a9071e178ca62c186062d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.7.0-canary.74.c934e4283921c6cd31fa3d2a153b5d9f8f49bb0c.0.tgz","fileCount":69,"unpackedSize":1578917,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgDs7sCRA9TVsSAnZWagAAJWsP/j+fApvP5cwknsRHP5Te\nSqpdzqiumpUPMNkPPBp27G+PxFiZpDPc07I7Vk8K/9x61QTmBD4X9OUvWoJR\ncxX9jfjv6ENiKsIvsP65Kt6aKXiXUDIZsvHrV03hDxFK761/FPuTFDNGI5Hr\nStzhp3u7VRiQjXgUS1J5TYWZVIq6MGrtevfEBUOnEF/3Vj/uBp8d/yePrSgy\npee8IT36v6RF329cr2/Y7vbfHP2Cq+DKxU8r3h26LizAYjTiV3Tof4VyLgoz\nJjGwXQJdTAGYnhVxSuWPr5D9+a80XXXm5IuOxnGMb6krb88zZ60MBgkptkDj\njiZxtChvrRMcQ6+f8qPaZ6hikFrxb/XFJwyXUZc4YOfW3NohfjPeoLTvj3Z2\nWCvVJpyl2xpNtB/gLf5zpR3C6dy93fYDBWExo+xJwGhwAp3aSuZsOH5SEvAF\nJIZ/u2iSxeyVbQlYHxaPGljaAtldFp1wjPE75syDUzvrU6ODNIBGQdG1Ft4N\nZMHzSH5UmcczJT4h6xRl26LMBxnFuYZP/zZsKwaVLzzFXeSJ4bQx9obbY9RD\nHJaUR6ULlVuP1mc1VHKT8mgbRuCPb4TxbcBnq9fPHZYYKygXxl/9sbLddWMk\nmZhzS418x8JONKrpsy9AU0cyW00j6E5Lq0iTWKJ6w/mOr0DiBC3ZiwDKSnZw\ns2rM\r\n=uZw0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDDK2mSO19OMIf3UHK2sLEnZm5cBY6GhhTOso6ywVlUiQIhAMxoi9+8KDiBik/wN5LOTEl47kIoyc8RMdEKfp6RNZmb"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.7.0-canary.74.c934e4283921c6cd31fa3d2a153b5d9f8f49bb0c.0_1611583211483_0.6039384864843274"},"_hasShrinkwrap":false},"2.7.0":{"name":"@sberdevices/assistant-client","version":"2.7.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","jsnext:main":"umd/assistant.esm.js","scripts":{"build":"rm -rf dist tsconfig.tsbuildinfo && rollup -c && tsc -m ES2015 --outDir dist","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"94601382f7efea5e70144c3b3d6daf3a6de8dd55","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.7.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-QdLSXpk0ZR9fwFlkp9HGWTMczu2R9IS25XoGYF914m35G9bd3Uegrl31HXXiS04528aqlg0jiKwB7GsMQ7iPKg==","shasum":"d239de5f73f57089a4ea8c80b20e4a5ebd5b091c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.7.0.tgz","fileCount":69,"unpackedSize":1579359,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgD+uZCRA9TVsSAnZWagAAw90P/RfeRqhrrOxO0NJwpGf8\nWKCCjMbGfsueGLgnS7xgeh2Z5FjCevltmmTfI9PBnYfdl6+Ui0gGd13Iwc3o\n/I73c5Ila0UunQ/YI07hh46ngnNpE8fkfHmDVybYaj8fwvScELiMVnVWXDxG\nZtgHaSzQy1o8jBDBFtgj1yesPspmKsGoJ5sOVHyCpQFilc7UfFwUeU16QYo4\np2SkiV1uKyrn7GDO6+55S86viifYj7JurVVuv0sosHPVshXsLVxT0zsqAC0C\ntBWtppt/j+MRCVPVL/5u8CYusu0WiA62WyndkWwiHdiN+e9l9r0Fq+7pdBXd\n0rGcDmn/5YuBUfPF6jzFqEutivBPiESmxJj33qSVC+qP38b4Q+/ou7gFqPns\n1DXh1ORhPdh/1Ii+201thZbSy/39nT3jHgykU14Qrhc+3NeBm7IwxY9y55u9\nAYIyXn1LpCAPlMLzrKLybXNFXdSbHl4DP4+V6RaInZXfuO4oA+vmUxd7Ij7x\nvYXarb2kTBloRrBuDaLRUTqHBSwfynp0YOduSWUN8w1fIRygEB+1KGn87n6R\ngPqoCprMaLcl0tp9NQU0EsXLH5LQX+Ex6mH93sjfgKyl6uUmIaMLkl37XrRk\njuSvvj6fuiicRRDocv5Ch4mx/JkML5+rmaXYppZulzqQc2V0pqNF2rz52O6Z\nhwYT\r\n=Nyw2\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICCGbs1ekT2yTB7UXiigylFQyjA4bOvPPz4nVULTlFsGAiABtP/7Ohl3aZn7Aoy2EwuFoGoeeywV6fmIQjbLrAQhGg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.7.0_1611656089127_0.20764280906648858"},"_hasShrinkwrap":false},"2.8.0-canary.76.082fb972d8eff6de1586abeb923a4f7190beabaa.0":{"name":"@sberdevices/assistant-client","version":"2.8.0-canary.76.082fb972d8eff6de1586abeb923a4f7190beabaa.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","scripts":{"build":"rm -rf dist && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"082fb972d8eff6de1586abeb923a4f7190beabaa","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.8.0-canary.76.082fb972d8eff6de1586abeb923a4f7190beabaa.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-3QjCq60pq/xZe3zhGd/+lp0OwAeKiOPYPRMIe5xRp0ZCF+dCR8X4qvHlYDpwffJag6YwRepdyrEYcZNGDPy0Zw==","shasum":"c9974d387da8996cf95e68809c488b9f8b8df028","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.8.0-canary.76.082fb972d8eff6de1586abeb923a4f7190beabaa.0.tgz","fileCount":43,"unpackedSize":805375,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgD/paCRA9TVsSAnZWagAAYoQP/jW7KHMMNL5js8t2s/Mw\npJWI9fY33DtF3K9gw6DM031kll87rePwsTXF+ol0aiEsB9GMPqTFn45gHBLN\nADJJdWEQmY+M2RaLC0Bs5lUJ6skfkGNTj9/Pqnqb/SE0tT24i76Y7vH4uFS/\n/5Jr/ptjhQuyusdBtO1svEp1Nz5qYvVOSaB+QgwbGW2Zcgf98IwfOceX8G7E\nGeOs4YaPU3wkLpbfOJmMlLsFcRXjc7c2wLTtkiL4AS7qWrfi+cCvqTQyzNfN\n2HisvsdEIGQFy23WiLU+U/HjU7a9rdiUSny3moDc4pZr+rcAO6T8WlFY4LDD\nlknscpEKHvrDFZ9+pCA4iunHRVZGcvYV0xDXG3AHju0+mrO40tbNMdLGKUjy\nnqJTKFn3E5lnc9wuqupH9QnWA4aNahZ5IQ8BQILAo4yKne0s3vclbvUk4wcD\nFDsPHYEIOjtmX6HdXEJqCBhFJ8/BYS23MaDMd0yaAfp38jTBtxyBJhUJMA+/\ndyAXrA+Y+WnG8FzST9CAG3tYSjM4RbfwvzN/6lSDmkwept+m3Q2bOFOrRIt/\nnkObw8F4smwHZ/FRl40lS0tUWGk/fM2ELs5UFvwZ0+TNywksP9FDHcuKl4Ci\n8+Ir/LnSZAhRV4jtFCaoxJ996P8eDiARB1SEVDPJDr71nqJSeK4Ee95jSEYW\nJxhW\r\n=dzJK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIB6a+r/XsXvHqxlWh8fME6wqPFcTBuM/SwpQIgtr2xMAAiAmGtsqbGNyrWgNsBz8dPonx7Df/S7P08jQUVgffsDyjQ=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.8.0-canary.76.082fb972d8eff6de1586abeb923a4f7190beabaa.0_1611659865878_0.18591318599474937"},"_hasShrinkwrap":false},"2.8.0-canary.76.0f076a5f9c499380f3beea4be7174b87a6765a57.0":{"name":"@sberdevices/assistant-client","version":"2.8.0-canary.76.0f076a5f9c499380f3beea4be7174b87a6765a57.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"0f076a5f9c499380f3beea4be7174b87a6765a57","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.8.0-canary.76.0f076a5f9c499380f3beea4be7174b87a6765a57.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-xrIjhuC+xIROqVhpjGVz+3w0pbubnlUbJsjzJixhATWSpTjOIF8BrJvkNQe9QScuzNdgJwAVblJbsWL459f2UQ==","shasum":"4da7f3fbabbfd6c752466e1954d9f35013d190c9","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.8.0-canary.76.0f076a5f9c499380f3beea4be7174b87a6765a57.0.tgz","fileCount":44,"unpackedSize":1213682,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEBypCRA9TVsSAnZWagAAOe8P/jKjteZq8gbv4A7f28xz\ncWq8oIO6XZ7FPNXKNL4LlmHGq0s+B5AxbqjRFu3939OiWYzNAt9F68oB0Lhn\nPbWI13o0z3Fh7UKrP5ybLiH6AofDD6DmTPU2CEF/bkop9Dxw3v0OHQnVV91w\nUF8yJAT6a21nDiPMEJ0VCNiCE7SGLmzI5Vw8Y8nHLjpMkqQOYFFF2EK3N4gw\nMNAzVDNAMzc4fzzt0ooYs9WVLB6gGfyJyvyFO097wXeN7e4uXHjcjgBm/pmX\nN1oXLJHjpRUVWlqq0HGzXFh4wZyXECSandQ1gLKYs4Vmk0VlAul+41m4cFsa\n/2SH3Qib4b00tAQN4Ny1ydQ7V7y2q8sitAZnSWdlWa2QLPMLnMWq0CcPunHt\n01tDCl5ho/sinljeehNSYZF8IlnNFARm9659oZ/B4KRnCO3WTpRTf6yBphEr\nLLG32uOPiUHWerdDj1C24TFuG7TM92+puY9+VXEyAfT4LMbLTqKy+MoDqgEw\nizo/W15HF3VFoUuweqLoQWm65rV6P8fQAP0O2dd17sVfapQdN51jtc+eD/FO\nLW5lzUObzuL0AxahFkQs7SelpQCemkHsXosr3rj9SgW6impxW3e3/DseBPCJ\nBoxX1iBg5klbCFxKoEJ3dYtCuNxsFLajGMtDEDRxIfRG5DTm+TQw7j3KAHpL\nYNu6\r\n=46jN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID9CUJ9Y1TzIeOZychexBYP8S0smc9P7jqL+EhzNma1NAiEA3IaJm5bBYwTXnPj0J+A06b/SC52kAoC5prYNeyItQGg="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.8.0-canary.76.0f076a5f9c499380f3beea4be7174b87a6765a57.0_1611668648654_0.25689164410788035"},"_hasShrinkwrap":false},"2.8.0-canary.76.9955484cc76eed23c56d25be9b59366d9740cae3.0":{"name":"@sberdevices/assistant-client","version":"2.8.0-canary.76.9955484cc76eed23c56d25be9b59366d9740cae3.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9955484cc76eed23c56d25be9b59366d9740cae3","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.8.0-canary.76.9955484cc76eed23c56d25be9b59366d9740cae3.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-GXhMvTtoZ57NdH7PrGWGoiMwo9/BbstPJqZ/g/5ST8AjE4c7WT1OtAxMk5ytFt4Ip/cNj15/0LIrxyzUAehgqw==","shasum":"4d60f0049ecf8b7e5176c40a258f03220b70cc50","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.8.0-canary.76.9955484cc76eed23c56d25be9b59366d9740cae3.0.tgz","fileCount":44,"unpackedSize":1030527,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgECGzCRA9TVsSAnZWagAAf04P/3oE6k53/5Q8qQgJ+EbF\nfyr5DRRoyqfHQ+VierLCYRtdie6+iw1SB1aJCjnZGJTLGRtw0t7KRix+6oof\n9NUAR+GxFvLyX1SMFXkgC64qaGzwG76knKJtWCLYZN0qIxpt9KFqVlDS1k8t\ny+meOHolekjhcvdbZaEt089sJCPlLQKJIRG+Ep/ydieRKHmm/2++kbLk57d/\nbbRfMO7C5WV3z33N7Pjlgbld+Zxrk9dMARYwb88zsN2IzOj8SZHy+1Hir1nK\nrFXuMzkX3Thp6mq+fnc3UKMVXoHEqIA4Yu8kya3IlkSwYQqeyfYitX5QHfAE\nJubmskb43RvVSErn/4JFhEWPgtrMIoW9XgR3jEW9z6gKP+U08Ibm1DoG0GRg\nYAn+XENtIzn91pKBcuH0XnBMyRwQyDTYvmz2usOsNIoMePSYkXRlp7Zlh8Vw\niXBWN6Nkfjgf0OnI2DWBQUa+nho55jdVwWFfJGJjNAzc8kMprH36+p5kbyOj\nnT7ZeLhd/i2Xnj1EndVvRjiM3xBtCj7bl/COmuh3MVV60WZDiDEsKKPq9+y7\nfHrGIEU6pS++mAZPtAamSCg7Ngj+h+uL2rCcHXM7n3hnrRPQbux3Apt2A7Ny\nrIWFXzyCS8N9wMfKxnX3U/bi+IfAfyDg/EhKzt9EXWz89ZmOyoJ6gHdMvenJ\nPtBx\r\n=AAkv\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDjCnoxDVv6inruGWouRJzKbmqfQH0gMgEU+AT+ZE440wIgCaH629gXBMOOdeZh6mtUXRn5bGUMhqwfyheuUQzS5eI="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.8.0-canary.76.9955484cc76eed23c56d25be9b59366d9740cae3.0_1611669938878_0.5248540426089692"},"_hasShrinkwrap":false},"2.8.1-canary.76.6952513b0f21d83df371e50d35d87e0260ff8bdf.0":{"name":"@sberdevices/assistant-client","version":"2.8.1-canary.76.6952513b0f21d83df371e50d35d87e0260ff8bdf.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"6952513b0f21d83df371e50d35d87e0260ff8bdf","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.8.1-canary.76.6952513b0f21d83df371e50d35d87e0260ff8bdf.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-feMhhbTF9OLQaq/XPJ0DUuT4WYesYDHsKTLH4p6A5X5hhLxfMJL0C2o2Yb9+X4Q0EhGs+KIwn70tBudyE5UukQ==","shasum":"3326d97673784aabd820dab70975b84bd83c49c5","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.8.1-canary.76.6952513b0f21d83df371e50d35d87e0260ff8bdf.0.tgz","fileCount":44,"unpackedSize":1030527,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgECINCRA9TVsSAnZWagAApxIP/36LY8Q64cpv6t0hJuPT\n2dqPz03C6Whx9947FCvpT9nSeGsbxQ2PAr6CdbfIMtmu2iPvTD6SJQhABJdY\nM67GnMCTiTx7IQFwZbxgJ9LciKWboTsm8aehD9BG4qqniGX2fD0kwFFqZhrj\ng2ZY3N/3E6TudYoZbEDoNyuwMkAshnvHcFWa39wlEc7fnT6mHyQRGIRIFnlD\nHBMx0Q32laXKdigbmSveLBoz5EZDycV5xsDvsI/nKJoI0UAsXED05f05L3SU\nPwq7zd1CxIISVp6R6DPYzTdH+TxQuZyatyOvUZj/8cbiME3pnpSxAa4pVaj2\nvwwfU6gbUfEBajrL6zFH/ins2VNjzB9G29+gLcGDlhmw/O6Vmz8RE8WEC5lb\nWBni/P+2xqYc6txUAlnaqn0n5pEdezf59gNBE6l9rSEq9iAEzgJmD7gsIbdt\nxtXzGQl4spi39q/Is2uSiOgrxQFEFAHw0LrJnMFbivwK6WnZY2WoHgKO1dE0\nOxpRZ/EiyC2Ex99j9cFYpjEtJpCBtJPqxps5uA9s8kir6YK3mDSUoyTq6pg/\nf+Or31+wYjJBkI0GpUh/O4/rJek3fxIJNtGBF7AtjWRQQsxg/U3hEHRnNKBF\nrvNkXdZOlvO62B/nuTWp/Ab781H8/OBCLwtpJ6TClUoypTV1KwGdUwAgjxnk\nvqmX\r\n=qK6w\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDIWII3PVk9Nn6iFMeM2V9s2OWrJvQz5mHVtvl2tgOmWAiBCDjVLFrpB6x1ns9/lj42hSiUB92286r0bDlVdRoCNJw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.8.1-canary.76.6952513b0f21d83df371e50d35d87e0260ff8bdf.0_1611670028608_0.24400883393738204"},"_hasShrinkwrap":false},"2.8.0-canary.76.1c7ffb9c6b52f5c942fe3ec269e48de28ba5872b.0":{"name":"@sberdevices/assistant-client","version":"2.8.0-canary.76.1c7ffb9c6b52f5c942fe3ec269e48de28ba5872b.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"1c7ffb9c6b52f5c942fe3ec269e48de28ba5872b","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.8.0-canary.76.1c7ffb9c6b52f5c942fe3ec269e48de28ba5872b.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-0422KkaPnBPMaK5H7XGx0TbZsvMtk2aX+mvAEJIhDGsZiE6Rfu0E7c3m6sLg/qa0D5P15GcZoBU2+5TmCdzS0g==","shasum":"094cb31f0ed6faba1b15da64914714a8f54b5d38","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.8.0-canary.76.1c7ffb9c6b52f5c942fe3ec269e48de28ba5872b.0.tgz","fileCount":44,"unpackedSize":1030527,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgERRfCRA9TVsSAnZWagAAQe4QAJT7nmISnd5hGCZBjomT\nhQYA74VXxF/PSOtEqKZ6TfIXTKwpwUkU8SlaUX6SdRHZ6O7WyH91ADhEhsrs\nGNJz9Arb0aqUPxYZhRNyYw8BoSG78nJqoJWdZL5vkxCd2CdaVF+4Q3ajX2++\nneOa4F7z7hK7hlA4Oj3NflfhSuTy2tofraBCszSCEAIQEV1WmxtUbsYEyg63\n6O8hUHpLz3rjxCQKYMZPuHKlVFByYQ6TWDJvxkrulL1d79+3HSu1eutKRpev\nI8x0L5mBZNJ6lYJAP7AzsGfOwedgU03TV5SK6BAo6tviU0sdBZWZuSBEwAop\nMi5PduEbl6BcZv2VwQ5dK+kJIwoXImB3GcEjnfq7/uKKe1VpHVihMRx5zPdE\nIHG+5DlXbcZzQYAZxydRvxBqzN+LHCMqqGFi9VBYZ8dgjreM7AfnDN3/3ZZm\nIAypDP2G1ZrD1+0kp94ud+ESzl5UbUhIDpDP93POD1ntsHM8agKBxZUg8Lkh\n+rGUp2k7kqIwmReIOp9HfWNvomvVEpymRTTQHhib3rscuGm377C7VDjqRxNM\n89rr9dPbYmiTHC+cwIZhr5osRAj8SusCx01Tc/mj8zrHYeCDF8U9gNkepNaI\nWqUjfcPVOpC7mCNeAbLCuySynNgHN59wF1X1eYccHeFCI5pRY3qhJADOG5qh\nYpIG\r\n=wWRv\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBbO54XbapPXUJjg4B+vtu7/YtXwP7rWMi4AAgpBuD71AiEAmtnNzb9q9UKZKbkDhwQV3QpvYfxIhtNNK+kC/YgmdJU="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.8.0-canary.76.1c7ffb9c6b52f5c942fe3ec269e48de28ba5872b.0_1611732062455_0.0027748561150311435"},"_hasShrinkwrap":false},"2.8.0":{"name":"@sberdevices/assistant-client","version":"2.8.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto.proto > src/proto.js && pbts src/proto.js -o src/proto.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"841f44f293ca0bf8855b866352905f5bad93f2ee","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.8.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-c4pZH1mJIGh0VtSg+tpnRUE91gpaqG0t5dr23N8t/V6rUNBz+z/DhVgh3aXqkVKJlEV4kFoQvTZi8E+fxif2VQ==","shasum":"0e6a94e895d253a1a5699a390b0e6b8f4a741840","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.8.0.tgz","fileCount":44,"unpackedSize":1030702,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgERUnCRA9TVsSAnZWagAAtdgP/3p233xyePr+ghDh+7Ey\nN8dSXQYUV4x3INhEu3voM3wFjRFfArzPQPu3QbHKdOoD8dNsuhrULxNrWFMy\ngogppEJsi35KMYwHVoIJacPc9XPVPwJSFr7e5EGopRWnGaZNHzwtGZFd/jpT\nlZ0fiVyASOFugqWA1KmjPbCJC5Ydz0Sks+nw9efktibNxzQUxo18MKPzZxMB\nCO9pOuCJqOcszB2wtO5Nh6oe9DbMGoaR0cM3RKUlo/O7L7M83qywTmWgBI4I\n3Il7lF3+yEol+NmfefniHnssNZgvpv2NXxkCrStwq5nsuPhDdLvBx5k8kDt+\nsJG4Cx5LpVAcHp0LxAnIUByJm94h2DzQjkLv+9pTIlKVM9CkEWeENmehacoF\neXu3u8Y22H+vIr83HUWPb2JlhCACtmVDmHdgD8WiYKEZU7sMg769cZQ0ASna\no79RnaOMGRHhkGn4gY5zuJK6jhD65xXmkujTdMRUn4u/TF+NjnJTQiSkYhS4\nVsA2sbA2/MvLIe2JRVPMyg1u8eQMLMSX+C6t2buxuvEJMOB01e+A2w7I9H3j\nyhPD6/4HZYQgsIrSJMFkMQx6UqydsJUcY12Tde766dsnBt4KPQjokEcQByBn\nma+jOOOWIBp/uCLRw4avB/fgr7S93/o0rMUDuAXMskZjZVBZzDhas9YCnMs4\n9TJf\r\n=KC+A\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICPyk4JJ/ancbd5md/Dz0JKOsjsL2Y4uYP9vvwia/Hp7AiAWwolrtmSVxV0QdayCbpOoERp1wJv0ee0k85lvKddCyw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.8.0_1611732262944_0.7267534794013746"},"_hasShrinkwrap":false},"2.9.0-canary.77.3ac7741230d224bdfb6a2e2e0c5152b09f7d9a1e.0":{"name":"@sberdevices/assistant-client","version":"2.9.0-canary.77.3ac7741230d224bdfb6a2e2e0c5152b09f7d9a1e.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"3ac7741230d224bdfb6a2e2e0c5152b09f7d9a1e","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.0-canary.77.3ac7741230d224bdfb6a2e2e0c5152b09f7d9a1e.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-L3oheZwLOfR8EZkRGu16hh+MwkfzYfNb30hTTGVDXgl18mMmNTh8qDIL066UwNb8pKtjAO6gEZlXS4qpxpQBaA==","shasum":"b81db2428b303d6bfd8c3d8d570f7b22a250c18c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.0-canary.77.3ac7741230d224bdfb6a2e2e0c5152b09f7d9a1e.0.tgz","fileCount":48,"unpackedSize":1174450,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEV9QCRA9TVsSAnZWagAAs2AP/jbotr+rJjHh2ivzOser\nHoAni7Qq8DHoFX8/yPdZ4vWDPK0IA98lest6vO7DYm8H98Ug/yJcRsa7fSYb\n/tJa8G+iAv0YjrsTELdwu2VXyGTfi2lGJyq4gzrUedLhhCy2s/xje8WhBAQH\nmMxpnd7yXF+Sl1IK62iC5+f7Q9iZJyRGWMZtVFNkOUwG70sHZ/d57LBQ+xVD\nju5h/GYvSGmk0kAYtWYBqwaWgl42xEvBLuCNQxvJkmUW9BCBn81uNg/S4qVz\ngCwvOADC+d6VlyKyG4sYb6+xmcq8ZlhVC5wAk+r3+4IcqEtUVpstjiB9ubRV\nMvKD37WRWV0SlpwahQFQNHsP6t1evW92I5QwrFJbBu6pWCzG66cHPVamTlbc\n/V32DYuMvludJ+iu3sMw0dwpm+Ywo8BDA71kgGuUad2v5aDG9CdZUuIWKpr4\nME8iJWeXuq3k8Q6LYiriiGf2PoP/I4b6whk4MSpG49+ehbtYyZoy8rwifTdt\nsLesx+x2HKQUAmlPf6OCZIQpxu20C3xuKoWDqeHUNZUEN0Qe5BFc8yfgriGe\nbbUEwT55htRcm9ZdlEGuYJfm+KBhIXFniDXLReWdoVDWZPKMmKXL7W5uCKbm\nqgqxbf4Tw88KPUq/al5dXLAcEuQiSMN6jriAE0/qELm29cbgKa1SR3GDsJQk\ncqqC\r\n=Tp5N\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD5VaDHIlhsyKFD/S1/u8oz8DPLXwnrw8HO4kQm//caLwIgEUogZY/5MdIKiahsAqPi/58YW/XK4fCsSFFBtw5HbAE="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.0-canary.77.3ac7741230d224bdfb6a2e2e0c5152b09f7d9a1e.0_1611751247928_0.2338815944788486"},"_hasShrinkwrap":false},"2.9.0-canary.77.a5d2cab213e3d0e51f9414659158c527c1f4ac15.0":{"name":"@sberdevices/assistant-client","version":"2.9.0-canary.77.a5d2cab213e3d0e51f9414659158c527c1f4ac15.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"a5d2cab213e3d0e51f9414659158c527c1f4ac15","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.0-canary.77.a5d2cab213e3d0e51f9414659158c527c1f4ac15.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-5vO+QMTAB46G5gcJVVPf7q23wtLFqoDi2z2rTaC5jSRDL281uASfvk4pxsHzftZ7oSKNU5u5wNcbrHNfuP+qvw==","shasum":"60e20258007a161fedd7283b77e88761fadd55d5","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.0-canary.77.a5d2cab213e3d0e51f9414659158c527c1f4ac15.0.tgz","fileCount":48,"unpackedSize":1175264,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEWZbCRA9TVsSAnZWagAARqIP+QEPqrgZpPuBXNIQSQJX\nxJ/76jf7Cl7nrYy8pEI8NtckI6XCVtt9x/hKNMwhYXhIfN+mBSrwJ3TFyPeY\naLtXWLgtJcph+oYq70a0sIL9l4UUUPx+P7ovnSQvXYmQQS9OHlLBhVkLMHIW\nLRmBxuHyqJzr5e/mweteCUA1cdRjo6dl3JRuEYWz7RrzE4d4EL3UznkhQdIC\nqEmtAKei3+Ue5/m70TSclVzZy/BVJcIBcpp9dd8c78uPuMRui7kbqAh74puG\nXrlT6s118TYlOCOOj7tboNdZCkjnHMX4SbIM1r5dMMfPPRcBorx8hQftkq/k\nWAXZ3/CU1RpuD42irZIZ0x8Sn0k/Tq2HTjfVMD8HPFtTX8DIZjcbIT8OKtmx\ngog9O+kM7b3tpdXCZJsFh+8cgeFnZlwimoRwj4uLTjdyFCrJsIhzRnKtR3z7\nQN3rm+oths9Te3fWEwqnwP03QaKakyLR4I2khHU1jHb2xpdei6z7rVQgfEHA\nF6n9z2R+UaSsDpU7G/Y6KAJ7Ri4ytS4gkqlYU37cTjBYJbxshmZ7iDdgaqm3\nndIe+uVAQtZsbyQWmFFriN0nOQo2TfErZrHzV4qCmjD5GfevRB5TuJ88mwOr\n0L/4eZcyoXlgdiovmn5e7oU5zMjvh0bOok06nCfxqCcb7JhWX4bP8rYYX9U3\nhp7N\r\n=C4fj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCSLXFKN+wkKnBrS3uNOkFtsG5O2MG2ilErlxUICuC4FgIgby6G905TCE9EYKNPt6dHHSCok0MQNh4g3oAYbLGo4/M="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.0-canary.77.a5d2cab213e3d0e51f9414659158c527c1f4ac15.0_1611753050836_0.2904012255402064"},"_hasShrinkwrap":false},"2.9.0-canary.77.3d9e13e0b3feca4b6e409b8f1ea3731b3b13a494.0":{"name":"@sberdevices/assistant-client","version":"2.9.0-canary.77.3d9e13e0b3feca4b6e409b8f1ea3731b3b13a494.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"3d9e13e0b3feca4b6e409b8f1ea3731b3b13a494","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.0-canary.77.3d9e13e0b3feca4b6e409b8f1ea3731b3b13a494.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-X1ID4d0Tb3vtgnrroFNy7/fb4ECdE2RkGercZnxH1A4zQ2bS9jq1PyJzGuk8IUECF+geWNGHErROSIpHhp+I3A==","shasum":"1c75b22d5035602206985a46108cf54d7d882ede","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.0-canary.77.3d9e13e0b3feca4b6e409b8f1ea3731b3b13a494.0.tgz","fileCount":48,"unpackedSize":1076839,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEmfuCRA9TVsSAnZWagAAnmAP/3SkWqjSWdSrUJVmGqE+\nn0QaqPugqVPJBiORBXxsyM7FQSFD73uds3Gyuy/ImrbTW4yd+LrjC1Hj43Ql\nswBKrYcjE1ZW9GpJQ1tub21gPYaXGGeQw3J+J0D/2/t9hbRc2wvCpUOqSMms\n7xmBpy/SbD6Udb+LnzC6Ngl2X+v2Xub8BdiEbbkW1xOnoZ+Ad+G7cR+/NH2T\nVC0dGe4P4T5UPtBdngArjHkQ6bKX/oRXutrrZLpVhZLuOobRYUP2iKyan5Pt\ng1oQ2tDn3iZ0MFbyHzRLm/sHwhfdaEsvamxv9OgKgulqWJioWChvLDrtKpMT\nvdOwByLVhqjZkt2M+bmT8WPB8rX6H3INX40cOm+Yc/LQYbwMtFRZONcvY6qx\n8Ut4dUrtCRoziYgqjsry4ZQkLjhwjrpllAjEjxzfz8qR9LKbKiUMMa/nyJR0\ngFRigV4F/PJ4oEAQ3XZZzYeLOGlCQGa3sdjjVaAA4CTS2hPH2QIDlUtI2FsY\nbhXUu7Vi85CaSHJVMXVMQrVAUVVvWYsvM/M9QI/c37ITK88Ka0CeHBRWsc2Z\nQ0ehfjnX5DVwlGrCNvuaHAKI3k4uygReS8xYL2QCwTeOw38cBmCPBIN6FeqV\ns/N3Qr3S84BBILzq3zUiYl3PV5G2dMa++eNrV+yCP2hqnwTbdfeiO2gC12pG\nMJBp\r\n=7MZX\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGFRDCHOhX8ewzSvrXot9NQI95opqe53Q/x01t3EsOYRAiAiOcfcBnwTIikGISTLGGufUkPUQlqOVQeMNRnhssu1Ng=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.0-canary.77.3d9e13e0b3feca4b6e409b8f1ea3731b3b13a494.0_1611818989947_0.5158409522845311"},"_hasShrinkwrap":false},"2.9.0-canary.77.344e6c32e0927897556df893cdc3092721a22f4d.0":{"name":"@sberdevices/assistant-client","version":"2.9.0-canary.77.344e6c32e0927897556df893cdc3092721a22f4d.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"344e6c32e0927897556df893cdc3092721a22f4d","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.0-canary.77.344e6c32e0927897556df893cdc3092721a22f4d.0","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-dNIAozUFjLxQW5qgI1la/BO+j0a/mOtnzOKI/J3ZvwEA2ywaUbvNuFQ5+kRI91xzngnTakc526mIHsGlsZ7MKw==","shasum":"3ec5aecc8d837f8d1f77915471df29cbec894df4","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.0-canary.77.344e6c32e0927897556df893cdc3092721a22f4d.0.tgz","fileCount":48,"unpackedSize":875285,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEmosCRA9TVsSAnZWagAAbQ8QAI2xd8xLo25VPfLB9H6p\nWTmawmxsHAExp9vKSHWy4g97wrcvWuVwmc8uzlfZYBuK7U4FSq5csRG+U1/9\nBwQlKGD6oMecBskPI5VM/KhKxtIBKeDa4arJIiMiBMOv5Q/1Y1FnBSuKgHzI\nQet3Ak9lLQW0J40HDZ988Wd+tK1JCTPkTcKHVE7nng08ei5xyI9I0OL/dHyW\n4cUhxZDutRHVVk2jkDVUok2HXtpse08qpgHNefCcRkAe4pfyXXBKd/HN0MT2\nA02CNPY5NC+1D/qhgyweYWrAZMeG0flhBRQfwChhFV1cCH2YI6ASb0gyVT4M\n9VXFOZSer8WyfT/NshHUuwuS3jRLP2JeHP6lIDBjatAffi0FmPcMuUAsnAOG\nGdunmArqIlqwBbf83M1UGyf/bafiIljzFm7rZVhhecG5nUYRh/MgqSu7oCDU\ndvbf8XIlXA6zRTKWIIhjwXRLkCZgl+vHoa8pCFDnGyq1PBvCvKvWM3Chb9CJ\nXvYsvgMTQsDZAcN62CMN9jnexaGoLc+meyUL7BVIAE4NXZgokl30a9vb7XvH\nrKyU+kewtryxMtsBuc7xBS6N+LPJ2A69zXXLfXdmmFHVmNppoLT8v/UjNtG6\nP9eGMqWhVdH4Lz9VH759HunIFQ/XfqELlbA+XtNqOEjuaFW5ZJZz9Kja2RBt\nzeAV\r\n=sGdd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDbwfVeDZBc/7146v1A57O8xABxgdUgEzoLIfxd3LdpSAiAOJg27i8WHTYoFXlor6IQiv6CjMo/+7vX9iy4IYLUQ3g=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.0-canary.77.344e6c32e0927897556df893cdc3092721a22f4d.0_1611819563967_0.6903378958023145"},"_hasShrinkwrap":false},"2.9.0":{"name":"@sberdevices/assistant-client","version":"2.9.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"1f30e226b14306fd44ac77149c38dddee6785ab7","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-XWcVRpsip7yJTAcx+WaBDKB6T2BdMUOD2ME6v+bteqN0Cqarq8F86LLVCfosC5wP7AFWtdZVgYMMtYik72SMKA==","shasum":"f41bd72364f640c2d19f9d9d0c8856b0a297c90d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.0.tgz","fileCount":48,"unpackedSize":875601,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgEpW3CRA9TVsSAnZWagAAvGEP/1eIdM0d8oWbtAXksRoC\nsHO9X4RcKum5hMa/zwoSjUfk/7RB0upl/bNogJvlIyhjHF6Ll7rNw14Pvv5J\nNp77LiN7q1iGAXLc/jp28z1IVD4kjoWbq7hk/OIcSeztv1entl7aoDXNy1FH\nV8TpATzpkFtECMC20Dz/uxXY1hVCnqJK4gw1IoLKOVUYP0GLu2hdxDbEfXQ3\nTw/wk1iJJYDxLPX0YIc13f2sSjOvyTxzjt/t9ygpqEyLUBuqp0ty4Nxkn8EY\nt9uWhVfzbyFT9yyf0WVoYRmO8J8ZbMbp9+/+jT+i8Xw4JxzmYNiXaWkEqpJk\nbwKssLbNRpM7MZ3+zHdsxHQqWUoGQQFwq8XKjWOTsyCTf9HAIczE3XuRJFEh\njwQGc2+N4nVExwsWnZG1xqZwn2gk21fqhjj6WmSRovFBdB63ubMM+lhwyVt6\nYVwgtlw6Vaez0c/Z/4zVY585o31NFj0E+QyNIYXpCk237xZB3dPySvn7nkbf\nqRN7cJCQ2UWXRZOgfHyUgvuWZk2xC3lMSWVyzognWHUrQcXhPQ01Jk90QxNF\nZP3WcjdGoHSS7WvSAFCcmY2lHUDwQ88LBr50UJuHKdkcHxd//FA3L/HGEQS/\n9oaTnDd2Bf4VsVL1OBO0Sk9WCyo4quraJXJ7wj/xpXVNApWmRFQKSAT3qc0i\n7vX4\r\n=zzYp\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHBgn4p4BJhTev9yBWKEUOYzetxM47O2EW+EMo2TpSTgAiEA84SI3bc2je4WGy4K94Tsh8/fkj07H0n+MkbeowEAT2U="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.0_1611830711293_0.203114349510797"},"_hasShrinkwrap":false},"2.9.1-canary.78.055d91baed3d32f1de0e9070e72f39f56536c38e.0":{"name":"@sberdevices/assistant-client","version":"2.9.1-canary.78.055d91baed3d32f1de0e9070e72f39f56536c38e.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"055d91baed3d32f1de0e9070e72f39f56536c38e","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.1-canary.78.055d91baed3d32f1de0e9070e72f39f56536c38e.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-vvLEwQewa+Z7wXNlBRvQblsy5nA/fRgynkkntstNQDP9PKJ8s4di4VWJ7aP5sfojBaDAqUHb9zqJepF6M2/D8g==","shasum":"2c74d9d5e3b7a35185449095b1a945520609efd1","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.1-canary.78.055d91baed3d32f1de0e9070e72f39f56536c38e.0.tgz","fileCount":48,"unpackedSize":881027,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgE7wdCRA9TVsSAnZWagAA1j4P/3LkRucsWT08kYSQeXaq\nKOwGh26B1/B7RlS9hD00RT9KgqeWDNRS25Swzl8lpY3eHa9RYUc3p1Z7//OX\n/LcfaSUk+6aUH1eOm+gqow/PopKbs8EI+jUE1+rL+0I7OkZUIM8CNUY1z6W7\nFR9/pHvWEcT+ymY69MJRT/vNpQfgyvgtiMnWNeEv9TMXpNv5vA4tzQ/3cVvl\n3Z3w6tj3EFjllDbl2l9jOQmUmBS2qflb9jeVfhY+fxfVUuv4KFM6S2sqOpSF\n0yrLpf11o2mwURhF1uvXyjWHz2GEZksM4lmi+P2+2WZXAwj+/JCjoRvgDNgq\nRYjs83zuzh07eThTX2q7yb47XIn8Il0Ri+YKMZW3c0EqmbyXVFVqUqbX0EpG\nhVaSS3YjcQ/zxouta0zZZDwZTa52jd1knQ4m3ZD88+Mu1cnMUJVh6SsiYhlM\nQKoeQWTlboxSc07VxK05M9RGtPRBV4aDtUmZGAlVG0r6wUmLQMQeKwgJXZok\nFe+0+wLNMKhaVT8vwBDZUPZittb+v9nUuzSDpYKVSldiLx5+gBOZHG/4HIKn\nUvVo6X31L68WixQHU6ObBGWP3ebHDwDPfhCoy/SuIyjL/jWK83a3CZFDbwpT\nSaFeOEKII2baSeBbXWasJ7L44r5SSUA0uqvFXKdLRTVwAwmaery8ci2XPRGd\n2Lw9\r\n=GF9P\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEVI0X5yEJ1pdR7LWfrpj6qvBWI167G5G4pDEXf+pcvCAiEA29nHnY/4gaMBG6reYNq5AVfuNZJ6/kmPNcYp1PRlt2Q="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.1-canary.78.055d91baed3d32f1de0e9070e72f39f56536c38e.0_1611906076638_0.4889711715819651"},"_hasShrinkwrap":false},"2.9.1-canary.78.554376f5cd657df6ad718e8f75efc7b5ae8dbb72.0":{"name":"@sberdevices/assistant-client","version":"2.9.1-canary.78.554376f5cd657df6ad718e8f75efc7b5ae8dbb72.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"554376f5cd657df6ad718e8f75efc7b5ae8dbb72","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.1-canary.78.554376f5cd657df6ad718e8f75efc7b5ae8dbb72.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-eIw8OyAutmSk3mneFHOWNxy8/FNbmNu/SZ6y8aiJvL/Qr54RAaqHbAK1uP+1QyKH8tebl5zAAtQEoWF3V0Y61A==","shasum":"1d94326262e866b5926d23a7d6b9eef9e0123297","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.1-canary.78.554376f5cd657df6ad718e8f75efc7b5ae8dbb72.0.tgz","fileCount":48,"unpackedSize":881027,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgE8HQCRA9TVsSAnZWagAAtGcP/3xgYu9KJRFN0I12Ds5o\ncDXg4LW2niKBzsxoV8foAs49QCCvbu3lY/bdD4jWR0wJQDRjrkidnbc/CKdO\naAYvZMqNWJhwJ+rnDdTpDAPGA0thbaeY9HEDsAl7iEjeviSb4VFwtP7eMJ8q\nUBzSYi8vSUYUyqnZ5kLk0eSZszHkH+iLITQ8lEghB4SVaILMKm5OmuydxO5X\nyef445PZRRW2n5cgK/I8AwfTmCr3l1TV/JYjB+3ilsM71ijuaWgJeK7MnpPB\nO2cf4cHrxh9PcswEM83sDSYqdLIgvXV/kzcrB8Vr/P6c2W4J7/iqBEKZFuuQ\nzaxqm8zypjNs9qGILFeXAqAOqEuDJY3vtDD79bY8jKkWD8c1KG3GVobIOvzh\n3Fn7DIS2wgdNLksIWzkqB1yfcYGmAZW025JHTOA5vcRXbGOlRirzZVgyt/41\nnkmNOb+UNtbUEWxF9oOAqpNVw+zsh7LetzeeekRceR8ozBnlTS8q13ZlTSnN\nwvs+XG113cbDiqS+lprElHPXaGhG+SHR5AZYdAGKXDzEM5mJviD3vLF3hPVL\nZ7PxpvMgBJKfbhY1x0yXE8tHwfi7GjirMkGgW+bLq/UfftfUOVbMiCS2FrlO\nRQ2uplRvgtbfGmQeydiutsFJL5re9TknUAxUJDcSWpkhJ0Mds2DIlpdh6iq5\n11IZ\r\n=aPCY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFq9tdlbRCt64Ih+9WhFkRCfev/Tt0uPr0Nk+gQSM0+EAiEA4zULBgnyT0V/VW3KG3NQHFIpP5G0fRG3ds1VgQBT8I4="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.1-canary.78.554376f5cd657df6ad718e8f75efc7b5ae8dbb72.0_1611907535999_0.43342146502214574"},"_hasShrinkwrap":false},"2.9.1":{"name":"@sberdevices/assistant-client","version":"2.9.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"5c1660f4b6afed5d4d9e8291d2405c97d7f50409","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.1","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-UMggAQAK4pUNe3IRZ/Ei3wFv1JNrQli/EXKZOv33pxJ4fe69QBJ+WMVnT3gAB0HiIt6bD4mEuFhpUIiISRFnPw==","shasum":"fa5701ac1e542fc09bedf9860eae88995e5f25ea","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.1.tgz","fileCount":48,"unpackedSize":881142,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgE8USCRA9TVsSAnZWagAATEMP/A1eN1HA86KrnRxxX5n1\nghyL4vhbJIdxzgbfqPcLAZVtFznIl/YDZeSdsjqtdMtr+WOLyYaAv0WMWBF9\n1JO2t1Abvku3xlKH6zoBxvE6BmS2/LyxbJ/vPieYfVjNQLLMilY9Yi91dWVS\nk3MM62PfCyTmJPyNgTiNahd9sQ8weCfT1/kO8DJnHt8b+b4Gw4JGQNitqz5U\n857Ra4YOLVTG9IiSjylyNClHN/1oydbdDr9HSUCVPU/rqlTDTbji67JllxEX\nHd3wIeKhMb7b0jHm2JmbmWJw8KBdNa4/YWiNDLdnXGPnuMTgDxxiaS16UUPG\nKS49EvyvLT2jCIoVP2O6/5BEBxvrjv9Zi54KewzA7d98ZdfKCszgVAbmpKI/\nHyBcMO3KZ6KsMhvdeQ+gpunMguZ/pFmaWUBqylmaGeyHOn+ty72riEhogCI5\nr0SEJjcj7VkE2PYajPBBWk89fG+bNhMjsSMdpLFJhdKeV1sotEMoSwethEGG\nVB90B5UoVdyPwylcduJxe1DZDJ551E2Do/CutDF+CIQmmc3HJ91H4Y5wScNI\nAKjHWg96klXGeZRYJFL3YbAqcwwslo9Az9P6RyxayxzTRrwOsyLXQmbuXTfx\nDHpFT2J7lHiz+UF7JycJVrx3cLt3AR/CRBN7oGHXtBrvjd45k4boi854cg4U\nq5nA\r\n=vWiF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICpMBiInaW23pWIRBR5P4L5TxJ97OUWmbgXOaLA9f8bCAiEAsF2rHdS55tVU2CJv/cdQ9rq8E42pRjujyb1Vnm62ERA="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.1_1611908370028_0.2713333662627144"},"_hasShrinkwrap":false},"2.10.0-canary.79.77c24af4d9fbcedca207a15506f8392b298f191a.0":{"name":"@sberdevices/assistant-client","version":"2.10.0-canary.79.77c24af4d9fbcedca207a15506f8392b298f191a.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"77c24af4d9fbcedca207a15506f8392b298f191a","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### sendDataObservable({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента, возвращает observable с возможностью подписаться/отписаться от результата. В on('data') ответ не прийдет.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.0-canary.79.77c24af4d9fbcedca207a15506f8392b298f191a.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-iojFJmLTvWg2ePHcoEgpERSOBj5vtG2DcjGoIq+aHmfpJcUO3JRx4Io3nqYIo+ZSxScAWEh5wJj/fnRukydQXQ==","shasum":"c1a318cb5c7b4e2a55159d79ff529a7f4ed96a94","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.0-canary.79.77c24af4d9fbcedca207a15506f8392b298f191a.0.tgz","fileCount":50,"unpackedSize":885981,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgFAycCRA9TVsSAnZWagAABzIP+wZcbDCrWJL7UeTpYXfd\nHQpyMrB9cSRXEJIhARTm1EV06NqChpa2vT1UGu4EDeZJXyLbO+0AGVJUBHbZ\nS9m8qw1aNIc2wxb8gmWuYk+FdvJ1Jy8sn9gBytYOOu+CtjMPOYy4XKMBbmWt\n2AZnJmymRt86wnqJi0KJ40tNsjgS7ytcKpTOD8RUrw+GCN+aN1D7SP1/lSFl\n721cXhaRHKE1oTcWFp7tMC87kwGMe5DBFso3m82Aqa9sA7x+Kpn/sn/h7q8J\nyP5lWsEuMA/tS54GQkBrFXcP6Zu1dr/R55ACWviGO1zw14UbjZFL/8U23eNn\n8Gda7SR2fdXCxu9P2+3EP8OhhO37PiczDOneBxbQku8C7U1Wp4Xt/htL3vHk\n7/zfpI5ZxCza7L884WX8Hg+d5r43T7t28uHzFgW7ma9mNJ81iCMNbUXm2bkD\nZLS2I4v+nw9E2nzeypBDDA3K3P4PentglYUfxuz6vomVO8oBKbeCWtdrcVbx\nbHWNcDJezV7xzYWmNHX2PI/HKq/K/C1HjltqnVUP9eseOkK5ZmZCSdGPRle+\nP8F1cR5JBg6azvt1uB6XnyISk8aJejRQyEYhk28TZ7v33NiVRVb3+S9TDmQ9\nvlPzzgj+OEQPqxZ40javkUtLcLc7Pcyj/hGHfgxdvL445YLafBH/wkBlQ3XO\nSal/\r\n=Om1Y\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID1TKFxoBT1ngrcft4kfgz7lqJpov+Z78CSXxVOpSMaxAiEAzQBv8+hOr7YAG8MEG59xk32cjXRllk+bhRVzxDQg9q4="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.0-canary.79.77c24af4d9fbcedca207a15506f8392b298f191a.0_1611926683644_0.7775057368824656"},"_hasShrinkwrap":false},"2.10.0-canary.79.9eeab22bfb9e0c0c7e42e29bb5559ac44625f2c5.0":{"name":"@sberdevices/assistant-client","version":"2.10.0-canary.79.9eeab22bfb9e0c0c7e42e29bb5559ac44625f2c5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.19.2","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"9eeab22bfb9e0c0c7e42e29bb5559ac44625f2c5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.0-canary.79.9eeab22bfb9e0c0c7e42e29bb5559ac44625f2c5.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-a201bqT0Em6SlzuvOOAqAU5eMUcAP51fYbiX5VoNRJM928qWT0jcs8p+dtVLQ6yx6DKif86D+6YscAIh92c92g==","shasum":"cf94754ee3bbf1561d4c6cadf4db7cb2433bde8b","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.0-canary.79.9eeab22bfb9e0c0c7e42e29bb5559ac44625f2c5.0.tgz","fileCount":50,"unpackedSize":886584,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgIPeYCRA9TVsSAnZWagAAMOMQAKDe9IQbmQALcbTV4j7a\ne5qoQM0cXaKZoxeCnpmRakQ8fb53mWQRSRVd4CDYkxjwiLj40c+RBkJcw3Ed\n1X7JBkvdT9VwjaEe0SMdPqw1sWQTjOGxCtQncqC5gnAXuzI1hGJoEetyP6FV\nNeLivN4tJyBrHMDbUeJJlQB3bjlT6DRLqP0Ls0aQ1TnoDzsNeOFFkYyQfaIl\n353xfwQarNf0qlQYRqrqfsuKvundd3n6SQ2LNcpDCi/ZD+rxLfgusj9RA/Dt\n3qyU/uqi4pGSRH6gAJiCVQHa6Hf2VQ/S6IFan37UnHkavxUmVSWURflNB6pf\n2lU4Z5nCfa+0NsdbRbjr9dANVLyvtinEzZMbHfsAGejPVcIqKPaiS3+GJwBy\nGu8IR+mjrlAV9o87Y+bDWn40zBXg7/8eCIzl9YE4MqxOQPUPZ38H4+6kxxmc\nK2pL/uUZNFHhVlwJBOF9D2Kuqyz4JJ6JiTuAYfDMdLlolyHP1lLsQ25bf4Fv\nzt8ZVd1l+0MV0Da2gZeyhWmK5NG4oq5eeriKREY49zrxBeJuUCVQmbkS0I5y\noL5m6/xgy8G/X8F48K1pVuj2a83dbqXnVysMhKQdwWeTFuwJLcZxCaRjSTIU\na+8C8LNikk92FSYd+TY/jUox5UGq+3bQGKSwei9qP/3RDqPHfXYyNKGMpysE\nid+h\r\n=1V0n\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGK+8PGHINLbuxdkHca2HMwx9p2pnP6T+TB1z6xR4kqnAiB90eFFJMuxhuH4V+8h4oj9kVym08Bx6uyRTsw2uSNEAw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.0-canary.79.9eeab22bfb9e0c0c7e42e29bb5559ac44625f2c5.0_1612773271970_0.24497861326459014"},"_hasShrinkwrap":false},"2.9.2-canary.83.4d2d73245d2244318efa37864b47325b19935288.0":{"name":"@sberdevices/assistant-client","version":"2.9.2-canary.83.4d2d73245d2244318efa37864b47325b19935288.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"4d2d73245d2244318efa37864b47325b19935288","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.2-canary.83.4d2d73245d2244318efa37864b47325b19935288.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-Orr/pBU0UrElYzy9X6I81qlnSx/nNSXpVf16f1SVHOIuD9jGHR1Kr8uYns//Wo3IY+TmamBPKOySufzXmEMPlw==","shasum":"f84bf2b92949d9481bb6830f073efe23326e1640","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.2-canary.83.4d2d73245d2244318efa37864b47325b19935288.0.tgz","fileCount":48,"unpackedSize":883383,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgKka0CRA9TVsSAnZWagAAOToQAJMYI0Wb5dnEFDrtijLi\nxXctH2i+ctxGLu0FXJjqEKhm+JYMlv1+NF+CsMpDUb4ZvmNnCkb8wfFsXMe2\nzxHopnRd2Dy4TuBEtQC3MwVZnskH3xHYSYJD/niDQ+2JlQNBq4C74FXiVDNx\nawBlsH9qyY6hNHJQJ/o9KWUomDPzpBPQZL330bEzF42UwvlwI4pFh9D5AR+q\nDTUzzZpTZwFAqyoX9z97ortFDlkQzyv968SwRSddgkpfuXEbqBPM5z6nGHQe\nVhfpZdToiKcnbRk1l5Ii1hc4Lx+nDC6rSvfUGTGZ8G3GA2TCI7RIyG0/nNRP\nfWKV1uIR1sM16PugKFDXClcN82eVNol0oGT4xOoFvBYqMBlYwBeymAPt27B7\nsbgRmQZuK1rkhnAgf0fBxMdc5y/kXkMGnR5X1i2NRBLVin015EaZLNdCLOzW\nYyd6Zs3d/kNxhC6uQoUWY9nlJ6MkE/GAhnuP2fH+HOA3IZ6xZ+I7BLvPC+zs\nQpcZ2qX9KTXDYI+odO39J+1E5ft1JMMFWl1FnZ/FApYYVtNJ1H8eqGmSm9Vv\n2VSTVgwWA/JwxCXzdJqHLG2zMN4DBZgISGdgU9g1OT/HCjMr1gG9efCmpzTQ\njgyqkrp8O4tMpchFXJy37V7nNWPOU83MvQa1hgrIUHUlFfhEGengo7FpBZQ4\n7ddV\r\n=+KbV\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCLudYrvTSZlg6nZ6Glmg6je7OQiyNNwuSIPYpQEiLYdAIgDYQOzD3L/dKvpjEI1uGI6ONoQHBKN4r5hz0WdLX/u1U="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.2-canary.83.4d2d73245d2244318efa37864b47325b19935288.0_1613383348322_0.15441699668867281"},"_hasShrinkwrap":false},"2.9.2":{"name":"@sberdevices/assistant-client","version":"2.9.2","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"a83a44ca60ee3ffb8d42e06fae3262b337e9ea67","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.2","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-jOx+YKAj0PCrXg1h6/3WpRdb56ZMrzigAfgjIHtrSdF+sZmBJQU03u6Zsyp3CTjj0Z805iNu1pei/PY4MEWaGQ==","shasum":"149a14e0ac81345696a0f034fe69a0bbaa5f66b7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.2.tgz","fileCount":48,"unpackedSize":883909,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgKlNSCRA9TVsSAnZWagAAnXAP/jsvBbFALdNj5k28gg4b\n/hO9JWNezpWDxCwPVgETTXoqVqbqSWv/iQALyHSSmm2I0hmXVnBsJFIjDJFM\n+LXoMSCsNHzpQGlNC7UvsrVy2zd9ycP2CmplRv35YoAzsuy3mHLJZRzxlMPn\n3I63RYxt2K6Wwp5W3xBr5nELx9qTrwCLUefHxk2tdIwfk4sEEKvpqdnpfxi7\nxotvEfvxIrZdwblGp7NQ1m8Cb5BRc59eqE2fqGlX4N7lwF4wE4BaFB8rDwaU\nWQmKkDJz/z+QRpDfJeL8Kr/rflynYli+VsTvps57E8uMA7ELPgl5WigZgwgW\nWVqn6oljaqmryNOP5UuIdY+ACH7XXbaIhWAVYILvGABTL0+DiMvEp0IvDG+R\nN7c3Gv/X4V/Kh2EmPwBhdyJpSAsfxfVCM9g+oqA3+WUF3tOYSx13JhmD/wTK\n2sJuLhJrHDH/gTkBhHf5dmO3zACYjpfRKhanTaP7Qx79N5CgIeDulQDjfYAx\nN4P9wj/qH4TGgeD2mRs5lpSS5Rz3ZC6PmqWEU2+CPZQMAOtrrw8z6QSBK5Dh\nY332zLegRUjyf0Qi5d3plNkTZjBDhDHdrbnHBqr8QUeJ+GbWKB8ZyUUrDEKo\nUGTLNer42tekJAA+9ZOlyH1uokkYEjr0xNQ8sykAbVFQpXXlbgbIuIh2ZUXL\nwa8I\r\n=cmhS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBQA9ap2LL7EkKftEYS/kKwfMg5MV0fu3nuyJFsVmdWSAiEA7sE1TZ/Pe1Yefm+Xme1WY22l9z0lJMaPNPURUmwigAw="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.2_1613386577537_0.493807025198987"},"_hasShrinkwrap":false},"2.9.3-canary.85.5b834c33be8cb79be2c54d122c40b78e601732a5.0":{"name":"@sberdevices/assistant-client","version":"2.9.3-canary.85.5b834c33be8cb79be2c54d122c40b78e601732a5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"5b834c33be8cb79be2c54d122c40b78e601732a5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.3-canary.85.5b834c33be8cb79be2c54d122c40b78e601732a5.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-FAzjAMTf8ruiQ3qNzn/RJb+Fmx/CDFz3mpuwFKv0PANppro71SAFeYbWST9DMstfoBb2XOmRCAvB712+RxJ8gg==","shasum":"c81c4ae3e206312b0896553dc8d21accf51d74a7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.3-canary.85.5b834c33be8cb79be2c54d122c40b78e601732a5.0.tgz","fileCount":48,"unpackedSize":892119,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLij8CRA9TVsSAnZWagAAckEP/iC3Gwo8a3Jpguk+XAdc\ncBkQ3YmlSVSLnPBJlEa3NoRjKp26L/K8rLvvopx6Mb1NvCKsLZIM7v5N230m\noGlUVasNzvH82sWydd0/VcJ7fO5H+r54WZeyllrutBP8n6YVQuxbjoc6d1hx\njn724MxRQCZU+8v641TH8VuiPVJlKc9h4E4G/DTopz4eNtsupY4zLDmtEnuX\nFaSD+5cpF7IQYdUmcX00PNvbtJhzSMSh2OaP8OLToQVlQK64uPkMhtozH33R\nfQkGjlgZ151Hp/0XrtBqxn6jqtNA5zxWFZ8491Erq3623J5XZrwWKRG1HPat\nOo+MvNzwTcWyk1eGZMwFkAeqDvZ9nOS+0KZp4hsfoOgm9cjbevR4Cwjgulqn\n7tOExYZeFSqtN72dIJM45kWwWEQCkv13Np9fj8Qq0WY63Tvj7sqcV++NZDM3\nc3xyYoYoOPdCs+KgXxgadTFNWBajot2kTWU84fCqTGw+GQnpgM1QtZdrX3Lw\nWnRLRSMrfG9hXTdNZGWLrEfjcBPQFIvdThpXiWiAufwzgeJJl/V7Dc+z0ced\n9Lp5vOhB/laYOY59CycLcEJvIeJZqJOZ2RBnPofWs7B4Fl2SsT5Kq9Me/CJU\nco3XzONJ2OEilc1PPQPMo37wjA99hy5BAHe1NeaN2mTSQKf8w3WihrIQ7YIc\n7aUb\r\n=Xl16\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHsWb/0wN1ZSND+2kojEZ0HTgp7eQyNA3St9fFLf/z7AAiAyfeGpc4QbGRNgurcz2XqklFvqsja7+KLNxPfC8q8XDg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.3-canary.85.5b834c33be8cb79be2c54d122c40b78e601732a5.0_1613637883977_0.38153533564194775"},"_hasShrinkwrap":false},"2.9.3-canary.85.e73dd38866298f779aeb4f3fa6179f075cefc6d5.0":{"name":"@sberdevices/assistant-client","version":"2.9.3-canary.85.e73dd38866298f779aeb4f3fa6179f075cefc6d5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"e73dd38866298f779aeb4f3fa6179f075cefc6d5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.3-canary.85.e73dd38866298f779aeb4f3fa6179f075cefc6d5.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-XQIMiZZD6sB4/j9cZDKl/4aAhviGkKWMhcL+hVKuDkmZxWpaEH+V6g4V+r2XAQAXOTzPQrcFr6uInoMtjYTTWw==","shasum":"3d5d698e3da6267f88d2f2ad8a5865d5de30c44a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.3-canary.85.e73dd38866298f779aeb4f3fa6179f075cefc6d5.0.tgz","fileCount":48,"unpackedSize":892345,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLi+jCRA9TVsSAnZWagAAuOoQAKCfm4GU/EzxoUhpQaGa\n/6LTKxZPla6zlVSaZzda9rXMDTr1tzLuNal4ZIkSY5nlpSONM/Fse2QLGSBf\njtEvcfbeQbZuUoo4MqNHNylEGIsmskJGxsxjcU4HiMAi6P5Dw7tAw6pQs9jg\n2UPppFPwuAdsMVhBdAb0NbHIHPS9fnK+wyNsKQsVksnZJrQ+7e6LYW8C9/OQ\nQRJ8kHOWNFXNylrqsJMF4873bcpEOrPXHaB5elq9aMXtE1FL2H2ERbHsXvjX\nxNal5g//Td8YE6ApUpanHK8N1O54u8i71ishOpDzt8lt8x2B8mtVpCumEHCw\nFQC/6+m1x8VPP7WoaR6jIkMgynzjxp3W/Tdv8qYgk3QbCriqHiy9G7k7/Eru\n5ApUxANYoVDy6FP3hhIJjANlC+r6nae6mFo7vuF9AzQaPbiycYtqsu3w/qBc\nw+46wdJddb2bCuxWhEPAQcb8BdBcdxFpzOVWHzd8mM0UIWmO+5IaSk19b1fa\nVOliNq0jnNZIgxLcQyvpyqblexx2GTQU12QB8qha0PfSwsNUBW1zAHbQ9m2l\nk2RjrG/MjJsnrliJwwvveOrvsXzAmzllwHJ6P2HW/BULNu/3UU1MPGxATo2o\nd35REEtWuPYSW9TSFsWsK+MK/Xj38IWVkGgQjLxE8K7UaVaKCX1i5RvDqljW\nFVly\r\n=EdQm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC+7ZlCB5rOKeof349lK+c4TuFXwtwF+OMLt9oI9zFBvAiEA3LRSpR/UqeNMygVIwlkbbg5NrKnMy6pL+wH6y6qsj2U="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.3-canary.85.e73dd38866298f779aeb4f3fa6179f075cefc6d5.0_1613639586719_0.17229672374724103"},"_hasShrinkwrap":false},"2.9.3-canary.85.fd8141f9a6fdca257e4de6189d1259f2b5e65c66.0":{"name":"@sberdevices/assistant-client","version":"2.9.3-canary.85.fd8141f9a6fdca257e4de6189d1259f2b5e65c66.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"fd8141f9a6fdca257e4de6189d1259f2b5e65c66","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.3-canary.85.fd8141f9a6fdca257e4de6189d1259f2b5e65c66.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-muIpBUIQMbP4ye8nrl6uXKZqydC7hiJW2SnFYTvvEbnIRmitR0YpocPm2gEo9xFrISYHnwcfmDCEqhRj/lOeOA==","shasum":"e6640202c9894202fabadde51218a00537571781","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.3-canary.85.fd8141f9a6fdca257e4de6189d1259f2b5e65c66.0.tgz","fileCount":48,"unpackedSize":892739,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLjS4CRA9TVsSAnZWagAAmGUP/jKRjKtvsFKsfs8KiAlM\n4esPCUyDQyvli5X9//wwEtx0hDVnOu4Ez936I5M2jNN8df+Izma0x5X97vKt\nGRWGEiLhjgI4JyV+UyTRKii37GJWVF7K41m4EyTMSpjZxpYmuTE0eAdof8BX\nyIOcTZILR4xQRjVzEcdiCxRyA2cszi8vKTeSCqghlXWweKmK6s6M/SnXw25+\n+rwPOQresZRseeWyma31uv2LZkjnCAjE+YW2TvkfhUlPxzmzD2ggn/CqgkUS\nxJggbJFfNIAkFxa7YujTJ+dPIQed1vyXAQ6vlljTnxrjxZPvZtWjnmHv0XRQ\nhe2/deFhX5W3OQRqFdlak6XBwngweUzSCEXzOSEA8Vwo5+jntciVpHTKDs4U\n9nzmJUAiPhsZ80UJ+Uv8Qz3cikGntAgSHsuBmshwwFJ/o095y6GjTqiMHnt/\nJn0v+YWY6vVb06tq7PTnaUCFpgfjIaVEp9lmFXOAZR7crMhoIeAR3I98FxJ9\nlfbE7W67B184BBRE3ahtjCmuHpzLF4NiR9zZR9b5nxasQV9i8svtnEL8AH9f\nR2THmfW9UyNM4kPrS1ve9iVtc7fCTVFYwGccOwhLnpe1iXAr8X0faId3ZQ2o\nGUMhDeTRHym10tYQ5ex0Le1eNvcVy+hgXi60oOWr+ynA12bcmFv24lDHkTQe\nZE0K\r\n=bzbt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH9fK1p/kUtd7EG2r9alDl7ci+fZ0qTEhkSovalWgOTOAiB/1JCkYMjjO5+2Jwwb4ZgFx0fsOAv5tKmi/BJMD1jTbw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.3-canary.85.fd8141f9a6fdca257e4de6189d1259f2b5e65c66.0_1613640888123_0.028539577805413385"},"_hasShrinkwrap":false},"2.9.3-canary.85.ec032406c7888a6384b571ef01e9e5f8ceb93fa0.0":{"name":"@sberdevices/assistant-client","version":"2.9.3-canary.85.ec032406c7888a6384b571ef01e9e5f8ceb93fa0.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"ec032406c7888a6384b571ef01e9e5f8ceb93fa0","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.3-canary.85.ec032406c7888a6384b571ef01e9e5f8ceb93fa0.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-QVY4RdjbKkjYy/hbsz9dAslcySBb4EW9X0pX7AZAGj+8mZ6KRndZep2WmAXHfYYHHSfXk6O9wqV5ksSfDydZUg==","shasum":"9da43714d715fa077f736b8fe2d432f87b065132","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.3-canary.85.ec032406c7888a6384b571ef01e9e5f8ceb93fa0.0.tgz","fileCount":48,"unpackedSize":892865,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLjebCRA9TVsSAnZWagAAYGIP/1eage74CwwaqpSirJOQ\nPk8YoVEjgyozSLd7GNyHKS2xHueWOJwhMw2TkqaFQF6rsXQRyRM4JImNa2gR\n0f/38tMijne4oMdKURGgn2QLTgLebUqvfga7omi1j6lng6G2J/ObWlbdwE5A\nlamCG9CFosXif5koQn0UETpkEdCrdwxUWmo3poSSJcoekWQQxCv7dXfRC81x\nnBcl+pfzeIa8/tDa81wndECKla66H/ZLXtnyBXVEQpUUUbTKFEzOCCSuY/Hx\n7r77GQ5EkibaUBkPF6routgkzg9sTLAwSGP7D7FWHiRH4aKoSCk+Q/mb8iVQ\n8yP2nb4qvfvfmYU65zr6tsjiHlxz5UeHFKBaJA4t6ZzG1S4z2C2P2T/C1Wfl\nneW5xOjqVw/3/jBKau3hHRoMsNceHIxOtcGcOmNasOVY+lYh/iNUt3KjaADX\nlgaJrWIANo9fw7TGy58lN6sxlfd4AI/1hlWWFujkkINMB4xNkgr0GpPlE6n5\njk1otl/JiHG1CX2OU3tPd3LCvwWP948NUKNJJLGl9PAKkDurjScAGv+CLoTO\n3SElHBlI3jRawJkPxHrcA8y8W4V2DOjNzLEXKZtEvt9elKreFKrG11ejyaIy\nf8keFzG193JlSAJ6WDZqVzUJyfCgpzoTIpRmyhywM7uxL6ne0y0AbTKfOsBj\nws63\r\n=NM3F\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCja+o5XZuyXak7SWVmwS3YC+nb/0OT4oEM5dLiSmovUQIhAPyvhyOYmovbw0XFuUXeKn+E3e2YftmV8eFWq4RkwhsE"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.3-canary.85.ec032406c7888a6384b571ef01e9e5f8ceb93fa0.0_1613641627000_0.06814380238816686"},"_hasShrinkwrap":false},"2.9.3":{"name":"@sberdevices/assistant-client","version":"2.9.3","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"6c2e7ddbca2475fd0cac0d142a9bc4b4ada4ecd1","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.3","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-HXfLQ7uPd1IKsKc2W8Pz5anRfXtyWoNaDhU2F+t465HBMysHx/2nKYHpS1aF30lhwV/H6cXP5sbcPZpuFh99Jg==","shasum":"d4f2a0caa40eeb4464d31dbded1f917488314cea","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.3.tgz","fileCount":48,"unpackedSize":892996,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLkKgCRA9TVsSAnZWagAADqYP/RyVO16DbbVohjvpnUmh\nKXRD998XwV3Zl4F6ySP21OR8YMrRHsdODwOUybHii2Cpv8p7j0pe9rptJYLq\nnd3HUWcaphOHBxWlD9O6idvG9MeXqgN/Xz1dRC08yZQfPl998RHTYfDhfOdS\nVC8c9Kin/8EEeDScwjBYm4G+UZiQVwIZ2NwALsZpJPUIawjqZluWSkRcwbdM\nLGgtbVKMobPrTZr2nO8N/SNZZdmQTTl9Gbzw3PBaLflzmHL5YLR+XYi9vxtB\nTDWgogKjygoCFe2+PC530B2Gbw7NPZfe2N2LTUdBgTPZGS5hP2Qmlg1IWVLv\nZTIqhTe37z9BHkEHXqoMDPgp9iSpYDd0Os+xHbpK4YkqoHg8BqBbrk1cxnYE\nMYJRHhQhiQIUW04lW1KykBVACcL/othbRCA0YOl1EB5GfuYFCbwEfCTCpjnT\ng1yAj2lF9bpZ7ZksQc3/OH4rUqj93yWwahHb1o1k3B49nDGECvqPVf/g59D4\nvkdUFvDyxptnkNKmNt+RVq1FLp5JXr93yK1SlpH7i/XV4JTEwad07wBTdrSK\nqKCAIGWXE4+eO0dyYC/rPWe99L2Ahb3mvwwMjCpROV6Xm/OADzApNnE2kulE\n7MGj99VJPSWqXl9BXN9FlIkcmDHGRyf8PyukZp2Xauy/sGm6zOvA888VNIhW\nSeoV\r\n=gvXP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCIwRv5oIDQn7e7TIe/da178hTqgrp/wR1pj9Z6yULsrAIhAN9uqBUp25UzuJ0IA1p9+G/5b75u4CvfMOclG9bnlKPV"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.3_1613644447773_0.6500230373553166"},"_hasShrinkwrap":false},"2.10.0-canary.79.ebc13d1f0246a4ce4254f1517b50f8550c51f43f.0":{"name":"@sberdevices/assistant-client","version":"2.10.0-canary.79.ebc13d1f0246a4ce4254f1517b50f8550c51f43f.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"ebc13d1f0246a4ce4254f1517b50f8550c51f43f","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.0-canary.79.ebc13d1f0246a4ce4254f1517b50f8550c51f43f.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-uNXO7zJ/y9J6SE1Yk4knZ44D6PJF/6Z/Eunn1zDKM7ZAnLLxNp20Ym6/0eItuXiDKOWjKW8Z5qVOalQCEAVoJA==","shasum":"8fa467769786aaf27bf7ecb65115fb005260dbf3","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.0-canary.79.ebc13d1f0246a4ce4254f1517b50f8550c51f43f.0.tgz","fileCount":50,"unpackedSize":898568,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLlK4CRA9TVsSAnZWagAAe80P/RtVZNbDnyPB4Uz1v9CE\nn6S7/De1id6CmxFWIGmcWtpI+I8/Bhr1LMk7lXSUckUMYZQMH6cvTKm6D5a6\nbfC2bpIX0y/3SL3MzZtGtx3t5bbL0NQrk92+/4VffBYVan2HNRXE3KJB8uiE\nmc77VFYW4hsd0YwJh8UPrghgSjyytNS+6U8YcYR2Sdxiew95trD7PcRp2kaY\nkElTr1Ny3PfALVJGjFkF2JiuK3RQST0TOjXQYEfqKqGiTHEO+px7MZ2H1OtY\nhe4RsrvtLJLmr84lm9NYKpOVQS3NGgBym5XAW5iThBTXtffkifYtZeMiRsDE\nL94/j1cTgVLW3EA6Qt4C4LIAGoIjypIOtwg0TJmWHyBzavVQMqejxDBUuQbs\ncRx5gqKslOFWC0FFmaNDgTGwb8yl0QF2Ujwz76EZ0wJcLtKPXk4KfnDIZ8Bp\nw0q4wpkTLn5zWylEwiC2Hcpo5upZDCF47R+lFv7WMcEJPAtnGjCDXpvqMkwS\n0dvITl9fImMvvnIWjcIWquwKke1rWjf9dRWKmSTYhdGprvcfKn7jWWhJWLxI\nLLOYTjc8yh3VAYU/i1jduqXd8Qx/CBmByDySlifbpPuFAOo0CMGJ/xo92T2+\nHAxYIGpyolXqXb4XWHKmQo+18Je+ee86jXaGS3eXByOvUFea0Uk2CYkD4uHZ\nQU+6\r\n=qhf9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGda5AcIfsokK2yZHsLfv0Fg37hf1iRy+xVBXRsIc2WSAiBEBOswjb+utgda8PHc5dEMeOc8Xq8bBCnPSbQHlrDNCA=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.0-canary.79.ebc13d1f0246a4ce4254f1517b50f8550c51f43f.0_1613648567876_0.7228973238276706"},"_hasShrinkwrap":false},"2.10.0-canary.79.b2008989f468d625a8d79d67822aff95889867d5.0":{"name":"@sberdevices/assistant-client","version":"2.10.0-canary.79.b2008989f468d625a8d79d67822aff95889867d5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"b2008989f468d625a8d79d67822aff95889867d5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.0-canary.79.b2008989f468d625a8d79d67822aff95889867d5.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-kz4eZuW9cx5qcU2tvBpT094FLUfnO4yqroZ99TLVneFHSTx2p1Hb0LoXzcuvIbUdpmcdIVMnWcX2aysQXaZuxw==","shasum":"16843ec05495a0608bf36f3a396b485c2dd1523c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.0-canary.79.b2008989f468d625a8d79d67822aff95889867d5.0.tgz","fileCount":50,"unpackedSize":898568,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLlTMCRA9TVsSAnZWagAAl5QQAIs+TaK5TXeFo2TPFpSS\n/0kaf2l2gYWZ0RB6z3voLMoYcjVyeC8j+8V6iM9iH0vdn4CH3E21WR+kIcmm\nQrCLYmPQhx0vK53MW3i6QQnqIT6ed/6X6X4RJFfW24v9J0t9TZUYud2PmLDS\nDrGcT6r0+l0rF2Z1B//bQu/+YSc5AbCpxpXXhq7kifTYz9pWzQezJNsJFW9g\n1yz0N1UsW1rD4cUQwM2uDyxxIO+8OVlPIKZfU72ooeOHKgTL4SxqSuj5ywAG\nZ7LAphsa1TzkUZQJBnMHcYMkWizdthD3j4+BBjEsOlzZvWeeHcnppmYfyVre\nFc7cwu22iNWejBKLpJ4jxcV1e6vOrMLj2+FO8XjE7yBXhmN9+PBuXxKaq3lg\nrKjntJ0ezpC/ja8kNDvLlEfHnElhBV1pHtkaLnTcVe+szz0gpP04ZElxEUip\nEqGB2FzhLwqVNz6yapFaARvq88dHSubh5Wa2Psts8NHe990fEnYkoLp628Y5\n+pdfsE90KYFfpKrmZGB71YWxiFwJmfPAcAvb1v86newoAB//0DX46wOrODvA\nvkFUvFVbavBvU0yfcWZJoli8ZS3EqRViKtQ4ndF9De9jQJSqLGPM95gK4dhr\nyZzmzweQh6xpJ7VBHnr8VKBJ3vVIpXOrDmUYx7uyhzdl58JUcKOUj1WSL5ka\n3KOp\r\n=a7VN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFqr9eqM8LB4wq+V58Wan71fvEnM1D+bSs4M541TtuoXAiEAyGU07wPTARAfDXzTa28ycz3m4ubLSco5kbG1Oy6s1LE="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.0-canary.79.b2008989f468d625a8d79d67822aff95889867d5.0_1613649099544_0.6476055521929964"},"_hasShrinkwrap":false},"2.10.0-canary.79.52bfe5a7f354c4a3c5b5953837274d003ede93db.0":{"name":"@sberdevices/assistant-client","version":"2.10.0-canary.79.52bfe5a7f354c4a3c5b5953837274d003ede93db.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"52bfe5a7f354c4a3c5b5953837274d003ede93db","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.0-canary.79.52bfe5a7f354c4a3c5b5953837274d003ede93db.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-q9MXsFKmlekZL7E//spR0V3h8N8uS82hwgBF4CI7DY0a+Njrv5dq7I4gyJ7wc85Ex1afSS9IxMUoPAUmV7htgw==","shasum":"3632c2e397a6e64e795905490ddccfea921e84a7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.0-canary.79.52bfe5a7f354c4a3c5b5953837274d003ede93db.0.tgz","fileCount":50,"unpackedSize":898541,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLlVMCRA9TVsSAnZWagAArIoP/iIwEmaPKUCtnvNveuv+\n5P9MEohtconrBUCXpTLtTPF5wsdADi9yaSzS0ic1P3G65TVrwoM99riDKO7B\nGQej6xd+ePcu0MYbbSgsq099r/dCVDfTbNN+EB4IUvS1wFYe9WWsKHTx2RZ9\nOxMXkoHSGoVkg3i6E+C0Vdnl65T6cpu3yd9OFj5v5uvK2bWRfPWjk4yFLBaU\nU5sOLioy3XJmMsQg07J1grPuymV9tZOXKBgtHzaxQxcR+EL7uao2A3ce9O4s\nqZZLosPMlKTz7BZgIi3ZchAnN/3KV+sYM7qkRpKb7Eghwc6pBK7fdp0ITswX\nj+07vdFQulpXrq6EX+bFiBMaryPa8sDLkhFn8NADtTpZlLYyuOECuYEJvLIB\nQDnFMgxTqM+nwWR3YLnM5ElRspWQyLJP7JntthZW9ZkJNAk6LTF06ifhDMVK\n5Gw+7V37L1/AoLXof9x2QG4LN9NDMPv989dx3KJ1khH45QbN6OJJ4w2ZgHRB\nhyeU6i07mJz0r9pJFCQAspLMqO1uMWCXk5BzIjeYMG90rfdMj7uR39KrfojD\nBV+6V8gaF6Gt1G6QXdvd5M9QqvElIxUhrKIra02deXF5JCbjyDrFTzucGfaB\nHEQmPJWYy4rOk0W0PXENULMy/Ak68i+JSagcRwITqQvFxeHTF0EhwDgFakpz\n4gYD\r\n=vqCD\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHRaSuaVIg557Jhk6dn6dEvcy2x/9TNUiJgko7mHuz+AAiAK2pwU3pQAhaRjImvo3aOGVl8Luu+5Vv+hJ8zwDbLS4w=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.0-canary.79.52bfe5a7f354c4a3c5b5953837274d003ede93db.0_1613649227799_0.07980409426523516"},"_hasShrinkwrap":false},"2.9.4-canary.86.f67a998f06d936633336655947b52ad2afc6c772.0":{"name":"@sberdevices/assistant-client","version":"2.9.4-canary.86.f67a998f06d936633336655947b52ad2afc6c772.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"f67a998f06d936633336655947b52ad2afc6c772","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction) }): void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.4-canary.86.f67a998f06d936633336655947b52ad2afc6c772.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-9j4d9/qLj9vj5Pn7o5Lw9spGdImF9Gx+V//ocLJGy8n5yMdnM8wg9aew98BQagYag17jmvZOll8mJLIrJ/KrUQ==","shasum":"8b9bf78abb1ff159a508237edcefd524be9277f7","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.4-canary.86.f67a998f06d936633336655947b52ad2afc6c772.0.tgz","fileCount":48,"unpackedSize":893535,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgL2ePCRA9TVsSAnZWagAAxNAQAKJdzqnW6vwOPplFnovI\ntfOhZerdTyvmFDgbi02IBFB4dQjKY8rUejdcicvBZ0StyzDWf3KD1MUevEca\nkFZzjThc9NaNyQCLivBC854B58xbD9bUCfFJ5yig2hZ6pkMAYrZN7EWAIlcU\ngD3NIt2yYe96QHJxJaqHlSJaW2kWHtlRI9S5rjrGfQWUzEfyv0a3xt8mcUP0\nhtUr/XtN2jvkHvf74MYNgsuNB2AxZI7HvA9oDkUAe/0VRBBZhOhIfuYoc6n/\nlSwkB0IdPmxZw8N0nGOPzQISNam+RylTmLZCnWAv9owe6Roj6SBGvygj+xPq\nOXcSvDHy5HrNYmurkRg1OLUt63Q0g9r3OQ54IxWqHFf0ZstJECzUMKI1V+Ni\n991Sj+dTESvefReGdYkcm5QWuH8UZETnxrv+/q96TZ1Zw2gwK3jxhDgZZNFe\nCpzCfwRADFmvx41O7OPuEbI7wc6Bjrauzcs5aGt7/mTcWvCyH07wINaE1hQ7\nkCbYeH9pMczCnjRisDo/CDKH4PE4mGNpVJ6hVtOOfDLrvJ95hN2DT8fy3xpZ\nJ2mtYY1ytu3jVuxSlQ84nQwhJnE8o+IsI+eN0XacSgjxxxWtAer4xr9trI3D\ntVgW774rXJ0FAT7n7JG0dw0cIKOCev060ViBbh1dKA+qDU/dMd/CMmEmgwFo\nDgM3\r\n=xJow\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICZcyX6swMOqA8qf6ZLQDjiU8i9CxFCn4mcggHeC6GA+AiEAy5u3y8QcDz3Yq2Vhk2I6IbgXpWOlI/7cItgUuh16mWw="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.4-canary.86.f67a998f06d936633336655947b52ad2afc6c772.0_1613719439257_0.15026670571596767"},"_hasShrinkwrap":false},"2.9.4":{"name":"@sberdevices/assistant-client","version":"2.9.4","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","nanoevents":"5.1.7","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"0a5c44c3692edf3a9699414ed914ed48219ff4af","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.9.4","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-U+4549zhWt4SHzGTRMlXESpYtIZHP9/y0m1tqnm0vieo3yyiL6g1Bp7vulytJ/MqblqD4Dnnbu2a/vT+Hft3Qw==","shasum":"edc5e47b0691a1c4ec757cdb1c73b979b3299d2a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.9.4.tgz","fileCount":48,"unpackedSize":893653,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgL2qJCRA9TVsSAnZWagAAIRwP/0yd7ELonjRQ/DDOIq0e\nzCIfWcfaympbaNBI+RkHTXJyV/GB50oSS82nMptcv8XIxY7mThGIQ4Ye5qVQ\nyRXsD5XfFQBixNza6wz0haPxWmKFTO0lOWALpZJ9EYd0RgVKmxDaiBgJHCbm\nKn9fDuE6TqFoy/dtKTPE/xCQszynwkyJH4IPkLxOvW+oQgcFSu4zzwhhd/N+\ntzY98AvcsCZk8L+IfgAyrrOyNF+mjrSPAiycFK6fHRGYn6LRFa+v2qQQJ2xb\n1DukCMnno3vPdXe1aTVhQ/yQjuT0V3OcC9AwG8LwoDOA8zT8X/TIcANGAdq3\nKYVfEi7hBDcKrgi3Nm6xvKOGAVcKVfmkd6j+dPjWMJcPaD52vGuIPGDS2zcz\nFfR4NvER+tFQKSBg5ksTkMW+Z7RQE6WEMnx9C+MPuBr9BSwwqZhXownz5YW8\nHVDkwfWgSAr9q3kkBnrPcA4tWwnG2IeQhqzmmVA4TdEsmBIfM6dbPKODhhuS\nBaWDyutynowEmVna+nBwvPNgGaA8A+6BvRv0Va6rDFSrM0Kl8wd9gsogBPWL\nqzrQutVJVpboxi7/cbN0iYNJGPgcdkGHDrbwT0NN/1lUbaduI+qGqTx6vAkQ\nEDUBXhSFJ5bdhQSV1xpFB74Lf9YafJPTndpwKo3I4nPBzbxT1y3GX7qZBS5h\nUM6B\r\n=JbI0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAjbK1Q/Kpyo/UoU0FdebVihY7IJS+t9Om5o0lDrymNOAiAgr5kPhu35z6sSmmRLsMneSOL+lqd8PMUFYBtnSkdAfg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.9.4_1613720200368_0.37037505468733145"},"_hasShrinkwrap":false},"2.10.0":{"name":"@sberdevices/assistant-client","version":"2.10.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c1283a928f22975472f59f81e7dc50aec48b9e4e","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-4ptMIrAW/pHAUTphpju88rOKs+cbsXTfELnGW4GgkndhYJsDJFZIx9+WEy/LFZD3TJfYmINmqud0/R/1lbxQfA==","shasum":"9ee7e8b2aadf740fcae18cd8fa83a2ecc93dff4a","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.0.tgz","fileCount":50,"unpackedSize":901830,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgNgS6CRA9TVsSAnZWagAA2uAP/3gDpbH2ufAon2BjvJUf\nj04t3A3Wv6bHnSbMX2fzI9INuRr9DLVDhSY1ehPnnMRCGsSKNj8s8L495d/6\n/spUo9G9xGBP7vESqpOyUML8yIADPjgendff/se42Vt6NBawwrjJfvjSwod+\nKFWjjYtuUX2B0LbVWBNCLTwGAW9G2yyq1QkpApUmSJwffNSjrJ/7ysVKhYY8\nqyvRN5eEZGR55tYgCboUwG5pJlkFCKKwm0bL7ia2/dE2GhRVY9WfhJyGNCRz\nQBtsf/yGwjF+EgJiIrqyT2243qi3WdwVKw58gluGT4zk5j1NSOe6EM34yzr+\nS8px/3HWxoOk2ctQb5hHFkQEHVV8GNZiUvJEaRkgCgnlSMWz0KYanjPcNfk0\nJfjldIrGdR3DBm3vWDx1DYaqzYlqBvR+N07FKztm2cIWgprtaRDZ6CKnPovi\nnNTZD7TU5GlwqPUVRkiXIBhXFDn2JzRroPK0u6EPTGY+fvHKjQm8yDhOzQat\n2vaWNp2jNFZBDYfqc/jZAJqZFS4g3YWvrV0aAwaXsQd3HbQK5FV2l6UeE1Un\noFXzg02jA3LbhR4+uNxhi9e7ZWGpMjs/FaYQIQsa0lWy3w4lLRd7SuHy3QhE\nzUF1ejIfwxCfLqhm2KKIh6HaSR4vTZlfHDbLKska3TDjSitdkGRgzNqrSmfU\np0H+\r\n=KyY0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIQDnR0h5FxAvnwUo2zF3EQhaKCSI2S75HhWEFTa28FCKiwIfWLL6IMIRJL1BFYRuTFzEKYDQcYGWvCQ5JKpNJgUfhg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.0_1614152888480_0.19966843656264954"},"_hasShrinkwrap":false},"2.11.0-canary.89.95e554f3fdb1110d7a9fc35e732dbf8e43983817.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.95e554f3fdb1110d7a9fc35e732dbf8e43983817.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"95e554f3fdb1110d7a9fc35e732dbf8e43983817","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.95e554f3fdb1110d7a9fc35e732dbf8e43983817.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-ZUlMZyE6Y0FBI8fneiuuPPXljgw/22FoRrKMOD8aoFAY594/lHeP2GbhosUysaWsulnKKRPeoc084gbZyeEl8Q==","shasum":"4916c44723be319077626eb56ebc7133ae937d0c","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.95e554f3fdb1110d7a9fc35e732dbf8e43983817.0.tgz","fileCount":50,"unpackedSize":905068,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgN3dSCRA9TVsSAnZWagAA/RQQAJviuRWdsfbNKD6YYbtD\nCCz8q9lonh9Csr8H6Aeub5Iv5PNlxbQq+oYUEJYbmAq8m80uWvDLA3TmDPIT\n4EHpE7A+5U7jci5q3OoIMs766cFHcBtkW8ox7aL6gshOdR5t4gj0GsW1eVzV\nyAPkC/bgRXr7AsGSsY1F//dubYx3f/uwtfVrRQhnniIiujgM3VgivpE2bF79\nLihATM6alsmkVZtWmI39pPJnWFJu2whAAI/0R/iPaT4f/N4UpwAxDpQFAooX\nirN+e0FJi/Gv+pNw1F0lyUelAajYKcYcHwbEEyBXm/H8iwKChKOcIKIIC7Bb\nGBQCy19K/BAFfduHsZHSY012l4ADd1LMGJoN8fjb5fswUeaXBLkMEXRmmF6l\naTUjc8Y9SNvvJd2NAaJYNwk0+UIcZ/Yxw9fty8cY0feg5gyNgmS8HwqZZbNW\nubuFeBceDEF/+v2BZbE1lbSK2hpLaMpg0qaqpKqoGOHz4wKPVhGrUJ7A7Zd6\nk5mKUAXxk4VqG1J39snlJuHDVnSJL9uIU1Jek5W+WhnrhKj7jNuNTgEapT0b\njK/CDoHvgG1lv1kCKh1FxuA12jnMz0flg0Yd9nu/iGbMLh/LZRv1WPctAmXC\nEyQfHesgZGXAp0AQxgQOWMMA4JbHwAljsRJwPvA8XYRy1btANl7HhPULJ6ZM\nOyKG\r\n=ENn8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAJiVrzwWJC4FqJKKToGa91eMVW4EA5ZLJHM7d4ZtJ42AiBhVJuCkROoRpVptdts67Ed8P4mxcQi+qJAyA9xdVyWKg=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.95e554f3fdb1110d7a9fc35e732dbf8e43983817.0_1614247761871_0.6201998554441019"},"_hasShrinkwrap":false},"2.11.0-canary.89.0a9a6d3a666379dee88f3368a0760a43519468fa.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.0a9a6d3a666379dee88f3368a0760a43519468fa.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"0a9a6d3a666379dee88f3368a0760a43519468fa","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.0a9a6d3a666379dee88f3368a0760a43519468fa.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-j3tvOzYwn/vwxuYAftHW+L9P+qQD6+YCU7wBTSvuCyYL4ePAbjFqnqR1ioA1wq/9/pCBaFM7SrICJrm/oMcp3w==","shasum":"934c1ed32e57444853f8d089ab7d2ece1f25f269","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.0a9a6d3a666379dee88f3368a0760a43519468fa.0.tgz","fileCount":50,"unpackedSize":906402,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgPKxFCRA9TVsSAnZWagAAJqMP/3QvxsfYd9z2yvjnIJFE\njRbaVhDayeQ4Q7bOKONphlKB9mn8xIfs0QgnGcCWanb8++QoPFVHa4dMMh7U\nQhlRzNFdaXvQc9ZnB5WKolJRhLS5PbMq8pqKUuFSCBFo+PoopzO73abva4rn\ngTA0gGLAaQS7S7SUCA5V38O5X4lkTMIhOQwleERiYkCDFQtlNm9nyBKp7JfA\nql2qj01Xha9fW/0TOn7Yo/x7vWxtL1x2UdrqwauwtqPrBoSmqQJx1BBzoQz6\nX3FsDD3eL6PPfdT0Fpy2de2PXNBVwzcj5PneEr8wFbzXPS5J1xDsHCHydfWl\n4rLXTZDE75XyIPo/52yh2vzEr8gJRd1sX+5WpracjyqiFtBjm+O+J+rQ/0L3\nRAoeAcKYmR7vRsQaKxDXwHuE+GlltJXHIpsIv49s4MDUFDdn0JY5r0LujNEf\nRoUt9oEwhJqv2qAoNG9woVg0SI588MDd/72C0v/rQiJ5Jwwn9RDijeSssUtr\nS5oNmqiLQFo72sttIbjmOjIPReN+zz8hKRlEhpqpugLg5vC8LIhZHip11l96\nDUSauY5J3BG95llRUgm4zlWiF5oJpSz8vdSHWB2c4mhkdHiN8siBZM9sckJn\nMjVOCQp+qfOC6/1raEFR7/w9X18iA5KGRFNsvwbJ6Y2oiFomVmO+H8bQ+3X3\nG8kg\r\n=Zqoq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEODPe84if9JZtBMxUGFBVX0unXigW47CW1jbrK7tzOdAiEA9GWMx+OqEe9668m/0pJs96A0KwtRVRqsae3XsF+x1tE="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.0a9a6d3a666379dee88f3368a0760a43519468fa.0_1614588996868_0.06660031050064474"},"_hasShrinkwrap":false},"2.11.0-canary.89.aaa6b1e2523efeca680efde8385eb75f2be13039.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.aaa6b1e2523efeca680efde8385eb75f2be13039.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"aaa6b1e2523efeca680efde8385eb75f2be13039","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.aaa6b1e2523efeca680efde8385eb75f2be13039.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-kqrUIy55iNYbibKlabwwX33EuQNafpNFcilB6GcC2qLXmlzwdfuxs9vD3G7wVzUdgHmLR2hile/LLlvABTELZQ==","shasum":"05436d138890a43804959769319b2bf80652fffa","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.aaa6b1e2523efeca680efde8385eb75f2be13039.0.tgz","fileCount":50,"unpackedSize":907386,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgPOqvCRA9TVsSAnZWagAAm/cP/231qsrcQP6EwvxRK3xO\nIk0zA3SDLSlwwYOi7vGWUOxNvR8HtkWgJdi8rSCITktadr+GKWi2GY70cXgG\nqiPBqThoIWpQhl7XTp9nj1QzauBH5ToQp3u+h7iUtoQK/9ZatssmeJwsmfPU\ngwXEbzSWZsYGYyPaolXt9TIW+SlkekEpV+d1lOHoydJPmdUrlIJnq6YDrdCF\nRfQlzwuwFsXmaQ9dHL+IBGdkIf+1w5tIIk8yEHonwI8xtYptmDL6Aif4copX\ny56Wh22acJNWhBGHmJNSBwMIoWsN/fwT4o4Iei5YCJJLsXLTZmtZ6D7XwO8U\nFm9iC369u0mXizBxUTvWbgrtjUGmhxVNasLBZnwfNoW3ojwE3xpg5u7Bv5St\nRk+qx3+0PtMxCFRyZPJusZKlfIAjTqUB+vMitDuywMsKxN1a7QZ8NStHSeOO\nHwJr1rR/Uwn4bckHgSKICvlCJLq3U/r/pMBNEdzcxWFnj08PPbmL8yJf5RZo\ntmXGp73Rgv+IP14mCn4PbtEjt8VIkeYdqSFFIGZExfL2Ope8myqOKygc9J0p\nl6MUR9r5RACq7B4w7sF/uVgGGvNSRZEDn6Pr9w7YqaKDIEM9l28IXcBv0mzN\nEq8o3OHlSm89LAs8URfyaY/PiBwo6imuwX56ZEbzRAGW9RfSeZCvB8NGkgLn\nYUi8\r\n=XjMT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDW3i2z3MbopUoWm8vHroHNZgMHORIQW+dKVGwdfp49pAiB/0KxfdPOp/1+eRIz7TCaeFqbsGnARkflpPbzyhWfkpQ=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.aaa6b1e2523efeca680efde8385eb75f2be13039.0_1614604974670_0.9762262327091902"},"_hasShrinkwrap":false},"2.11.0-canary.89.b36417bbf872b55bafe58bc23bd197658d71566a.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.b36417bbf872b55bafe58bc23bd197658d71566a.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"b36417bbf872b55bafe58bc23bd197658d71566a","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n assistant.sendAction({ type: 'some_action_name', payload: { param: 'some' } })\n .on('data', (data: { type: string; payload: Record }, clear) => {\n // здесь обработка данных, переданных от бэкенд\n clear();\n })\n .on('error', (error: { code: number; description: string }, clear) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, возвращает объект с возможностью подписки на ответ бэкенда и обработки ошибки, полученной от бэкенд.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nassistant.sendAction({ type: 'some_action_name', payload: { someParam: 'some_value' } })\n .on('data', ({ payload }, clear) => {\n // обработка payload.data\n clear();\n });\n .on('error');\n```\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { type: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.type === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n type: string;\n // Любые параметры\n payload?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n smart_app_data: {\n type: string;\n // Любые данные, которые нужны смартапу\n payload: Record;\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { type: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.type).to.equal('done'); // ожидаем экшен data_note\n expect(action.payload?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным type, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.b36417bbf872b55bafe58bc23bd197658d71566a.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-TZAiQgtckHyeJzfDg/rnJHmOv0whqP0f7vUCQTagxvKBHJ5FPl4fSFQG344ShMJMlKuUBtTgEFaNZt2qkcABhA==","shasum":"2f00995ced0e17f1f1c1676d9cfa278a706fcc7f","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.b36417bbf872b55bafe58bc23bd197658d71566a.0.tgz","fileCount":50,"unpackedSize":909324,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgPPNpCRA9TVsSAnZWagAALgkP/3bzblQbo5YaNw7KrTCv\nq0+piH/DyHIlB58O+84QMglGldb5pLNAqvC0VfdaVJ4Dmz/J3aXMp/O3iXk6\nFaIY8RraSBLyX9N2HcO+gz4BINMpenVHfhypa45fXLIj933gaUkd8O/HjXpZ\nI48YXJ94M9Wi2SSnI3x5f6n2srQVKJUDOMXsnehTPjPqmts3l0aMPBLHw9V0\nBlC91rbMA04LwuUb+P6dM99AJ3DDwjc7NIoypc9hZBifjBPrM5f8e8zWZEqu\n3ULjflhdq5ro8LP6kNzKTosqjVUia/4Wcj3LMpUHFwJM+LUftiHQ3lhargjI\nzn0IuLQrAGPIKDHTxpnNpoP5iyZq4AHIPhZnY2k8WqhznUWmElwR8E07QqXb\nR0bdJHi44R7lVvdYMD+nCdgmQVPnLHlFv068Bjhtb/I6McYM+Y+yDSE25RwR\n25jzq4yKwtLsy+luLrsEgfPvPxYQtYq75phtmIM9P+oXzDR0UcRLernjx3Zg\nrKWhjcZom2bcZPaBau5aZUUX2/innSBsggQVBCHIeZUdRaIwWgWRc6gETIHk\nSa3JX/YIYj0xqLz00NRi7MZSV6Wd8jtgWdJVRstu6ZupcPzBiKzGxGBJT4rL\nlS9HNSJWqvK51Oke7Hl9ysQssfg9vh2dkdrq7MzO9umzYv4E/EREBElqb6iR\n9ry0\r\n=0e9F\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIALwRmlNZjpc2NaTk2Iz7KhOrhe/HU/qu+A+oVQJXH1mAiEAgMdvNCepjdCBz7TVBZ7nxYIYmIUckTf5p7uJ8jWoNpU="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.b36417bbf872b55bafe58bc23bd197658d71566a.0_1614607208395_0.7522497780738369"},"_hasShrinkwrap":false},"2.11.0-canary.89.729ca70d5e76fa1672b3cd21140459928aa61b24.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.729ca70d5e76fa1672b3cd21140459928aa61b24.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"729ca70d5e76fa1672b3cd21140459928aa61b24","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n assistant.sendAction({ type: 'some_action_name', payload: { param: 'some' } })\n .on('data', (data: { type: string; payload: Record }, clear) => {\n // здесь обработка данных, переданных от бэкенд\n clear();\n })\n .on('error', (error: { code: number; description: string }, clear) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, возвращает объект с возможностью подписки на ответ бэкенда и обработки ошибки, полученной от бэкенд.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nassistant.sendAction({ type: 'some_action_name', payload: { someParam: 'some_value' } })\n .on('data', ({ payload }, clear) => {\n // обработка payload.data\n clear();\n });\n .on('error');\n```\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { type: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.type === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n type: string;\n // Любые параметры\n payload?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n smart_app_data: {\n type: string;\n // Любые данные, которые нужны смартапу\n payload: Record;\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { type: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.type).to.equal('done'); // ожидаем экшен data_note\n expect(action.payload?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным type, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.729ca70d5e76fa1672b3cd21140459928aa61b24.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-63GwBfD5zWe5pLk343CUyeYEHCom5amGuvnFUIRGCeoD8t1Q3x3zbwaoLi7FQ1EgzpcmPD8sGcgvwHIsosdJqA==","shasum":"4e1cfc581ae1f04623d81f387d81371ad222a08b","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.729ca70d5e76fa1672b3cd21140459928aa61b24.0.tgz","fileCount":50,"unpackedSize":909324,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgPPOsCRA9TVsSAnZWagAAjD0P/jfK9YA/Dm46FYCM0lQc\n/lg2EHKh9/YkIjJQ27vM//IfUIJXKQGJli5UklM9UI/8E9uwNoxeByr8lbTU\nTaI9MMmzIM50y6qQmM9ZveiMRXtyW9QgbOMEBYiQGIbsPxM3S+Nqt74Chi8K\nR/6lpeyoBs3DZllYvEFzDfZ6UAxDo4jnGDPm33h+aG13NJyrupB9skzR+G5C\nhhShIFQL81fTUNrJg4BhGXn10JqP49LL6aK5PIh4p2FeWTLapQMcRqyumn2k\nOeioByGfsNHVCDODbU/veM+eBgJqaxJAFRnurcCrcEMB/hxfrFe5/VoEyVTh\nvawIwRLzkT02jnQKQkKnd8octfjNi9VGn4CMQcUspSD8Fc7Dli07FlTi6TgC\nWzQa/LBBfz1CiO//3gZyRBGLO1h9qsZTwYQ40bzmlbQH2OwrSlG6ow3gTZpw\nBoMcCQ8ZJBOdLp0NdafyUiEmPvmv13TdgjsasawsNDAhgPL+ZoQ/nhH5lCQ9\nsZe/iCIk8TZUyiadmDIYqSyry5j8/1OpJy6rXGDqY2kQewtBPvCQ0OPyIpDt\nQGVJ4WA0IqUek+ld905PmCsncqeLq4lo5S6jlG1AUrIdkf6woa4+g3tL+L+s\nx6ldFMoAFtnkse1/3pqkOohB1SeTz5IyqVSq9FG85G3glqw75cgslSSJW1Pn\n/5KH\r\n=MTBW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHPwMLtxFOEj31d6vIDC2uhiEvP0PP50oJzWmG4oXPobAiEA0rhGBSkhojCzKH7kQwkYTJrIKnFtU5P1vk7+WVILY+0="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.729ca70d5e76fa1672b3cd21140459928aa61b24.0_1614607276296_0.9143860273252793"},"_hasShrinkwrap":false},"2.11.0-canary.89.16d06df683f8290e083b5e34d2d69deb1a085428.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.16d06df683f8290e083b5e34d2d69deb1a085428.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"16d06df683f8290e083b5e34d2d69deb1a085428","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n assistant.sendAction({ type: 'some_action_name', payload: { param: 'some' } })\n .on('data', (data: { type: string; payload: Record }, clear) => {\n // здесь обработка данных, переданных от бэкенд\n clear();\n })\n .on('error', (error: { code: number; description: string }, clear) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, возвращает объект с возможностью подписки на ответ бэкенда и обработки ошибки, полученной от бэкенд.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nassistant.sendAction({ type: 'some_action_name', payload: { someParam: 'some_value' } })\n .on('data', ({ payload }, clear) => {\n // обработка payload.data\n clear();\n });\n .on('error');\n```\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { type: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.type === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n type: string;\n // Любые параметры\n payload?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n smart_app_data: {\n type: string;\n // Любые данные, которые нужны смартапу\n payload: Record;\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { type: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.type).to.equal('done'); // ожидаем экшен data_note\n expect(action.payload?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным type, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.16d06df683f8290e083b5e34d2d69deb1a085428.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-+BRg7wF4IoQXf4c6NYqp7oGW7MkeVXurS0OQATZlJUbizwvgkxguorZ30wUtYDH9Cr6Q2UyGSlElZ5ZMedNI0w==","shasum":"224623ab18946061062adaeed446a4e86a086217","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.16d06df683f8290e083b5e34d2d69deb1a085428.0.tgz","fileCount":50,"unpackedSize":909324,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgPPP7CRA9TVsSAnZWagAAaeoP/2zi0bKGguo0Rt04KdGA\nNbBfaYezHaOMXGwgjFRb5Av8TQB0R62pnuUrc1Njx6lP5e8WOz+sSy4ADW/K\nVkOSPfoTLUa8DOmVmbsRnnZR/zxoY81+Jq0UCeze0r2RoBvYx9M9561dM6yw\nb6DcvxWSX+SdrSXgWvyjwHvaFLphl+PSPmX9mu1K2dpk6y1WqA/4tWHlBIqL\nNt0qdI+xfjqJjjGDHXPh/v/ZgX56nc1SfTRn7/0BHvmV864eQIKy+64dY5Rc\n4icwhFWlHGnT+sjYPCrb/rkgtkGNqXPWAvqkPbiJjCt7gNubIDvLPmVjhEh6\nouiPWtm92adUY9R36vozK0TlkBi3SAouyWvE7zE0z2dSmHzT9Xf2fSgdvroZ\ntveQOoIMl5aIUtzU1Nybj+fOV5JPAp+kE/0OHilPVIcwFFrKtUpC/vREbzU4\ndOsOa/a6hdjl9khTTUMuaDgw4E2zuLUkU33J03J+w5WsAlcONmZ+bzERhvUh\n3iQ7U42DwjngCgLfG7lFZ86XboelL6Po9CCK60Ydhx//9coMgnGUkD3RMcTv\ngDfBScZeCJguRCK/RHz8gzL/204JC7JaWu8mn0OtFRikkf7EBUmFyR8ZR/GZ\n6mIyRgSd5dKI5qiN3h1Ah8j6qi5cCP4PgSgHtFc0nUcuuqp8dEceboFecmMp\niHBg\r\n=sIim\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD9IBaSicQQb33MMuWYMYy9zsMgAYM4X/KRYEHVDb1sRQIgVg1357gdEtxzRhA31IVRxx5cHQ7M49M4PA08tpL9Of4="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.16d06df683f8290e083b5e34d2d69deb1a085428.0_1614607354927_0.9253937623688671"},"_hasShrinkwrap":false},"2.10.1-canary.90.008409a59e9ef49eb964feb55c6207bc0bbd4d32.0":{"name":"@sberdevices/assistant-client","version":"2.10.1-canary.90.008409a59e9ef49eb964feb55c6207bc0bbd4d32.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.9.0","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"008409a59e9ef49eb964feb55c6207bc0bbd4d32","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.1-canary.90.008409a59e9ef49eb964feb55c6207bc0bbd4d32.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-lU6mJqt5aNrZGvGILljkGQLn+n1WUW+djgNftvTruUjOeUS1NWHde718cXq8O/bWg2QGM3QJpvV1N5RXglb7mA==","shasum":"4ed167ee6a227f059e8c88191d47e941f8165ec0","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.1-canary.90.008409a59e9ef49eb964feb55c6207bc0bbd4d32.0.tgz","fileCount":50,"unpackedSize":902005,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgPjd0CRA9TVsSAnZWagAAamwQAKHiAPKK8/C85VFi0JDK\nrcJNOFzp1FB+6zuCOdU7BhkE4qI9JhSvKqYoxP6UDb7VZE2jZrraT6YK8KcK\nvNGcbt2N7T1qv9l7UfcODxU+OdyK7lUc8dQ92i/ivXyZmHV+b/d7djIg+d6H\n6TSsoR4csHKrXfBPaLKIUN5uxm1HfXcfjkv7shDowalRC/scdiWZOdvbiG3o\ntfxOQN99/5btyaHiCYXHJT5o5JO1KsNvXp1a4wGU1soz4DX8SAC/7kbYxL/b\nkLw4UK35yDCeIH9U26zMSnvFrnvTvfSm99TqbmoxGnRanS3W3z4rHPH3U6lz\nG9AyocQBTB+zSbd1YUVkchUC9i8mD9w+W7LGxi2pdrS6/6rSTs5kWqPIGJVg\nedde9EDBI6XWLXzpNXs6dAerjghxMMjKG4myNcYQ7jIntIAaAGZaplx+nQv/\n7NdvZgAnznQYGF7kJDhDlWthQ3mwnTu1wnHTm0+vrS9alFTR0uC7Nv7jLgfy\ns3k6eXmgKqE/ST9Rhm+CR5Wb1FJ7d/KaetVhEV7eFavnvehm2M0ylCahOGSo\nmNuZ+z02DwAAX4loYxD7nkK0RPFrWWs3AROGY0X0NH2pzTSdq6rbU/75Gcoq\nlRgg32ipLVPXNRM8cxkueJSSVTl9Nb6LUuh3einf5xyd27AsrVZB98tI6Lcl\nzTx1\r\n=099E\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFEXwN6GNg6QL9S/5TOl2WAgOLDdjtN7x7v+8gSvs7GcAiBje/+pSEwSjlxwwd/tmjh0+Tthp6oFAxpFKsCU311vZQ=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.1-canary.90.008409a59e9ef49eb964feb55c6207bc0bbd4d32.0_1614690163702_0.6505685866534554"},"_hasShrinkwrap":false},"2.10.1-canary.91.cfc10bbe330aea82a07ea223c212af14fc582c5b.0":{"name":"@sberdevices/assistant-client","version":"2.10.1-canary.91.cfc10bbe330aea82a07ea223c212af14fc582c5b.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"cfc10bbe330aea82a07ea223c212af14fc582c5b","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.1-canary.91.cfc10bbe330aea82a07ea223c212af14fc582c5b.0","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-tMVQNabbx0/BMCZAqVQSUS0/Jsmmj/DpVGoJkCSywcCcbJgNG9rrtG7g80kIx9uvNALHz0sOHwQn4KZ+JgxSyA==","shasum":"c5bf8cd6cbba87dfb6760151c7ed92327d6690ee","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.1-canary.91.cfc10bbe330aea82a07ea223c212af14fc582c5b.0.tgz","fileCount":50,"unpackedSize":902856,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgQKlcCRA9TVsSAnZWagAAc8MQAI2vIDL22VY2NpzQW77P\nlKEbxirR2N+Ki4lnqgXKKjsmRsyVY4zIj9VOKpUyvMxSQ4bLxgcaxYKLZUtl\nEQZDEG8wuo78S4G7gnZxReuE/hytxIMetZQcW8JPEw2ITla3JRGKn/z5uNkC\naiSG9KAOTr5exMUJCEzH+e+fgc4YX0LyHSAX5vE3FNSeFZA1WVUdE6CL4NWE\nAj9SDzWsPNXMBqhGN6uo36kx+ntIFaw1sFVFyOaax6GWREvGrgBPPQN6fnBe\n8Weq7uF8a8u4/xvQrZgvsw5n2QJ3a7WSxKau0hYjZjrlA4nEyq0X3oX/IDQ0\n9V2Yg94ngWeD+EvokXXX1f5yiJjgu6cgrNrpyQEEaf4oRB3HRC8bITCr/Z/g\nL8oUY1mzZikVftiHjsM1UPgB+RzHZFuJQfGt24+JmR9iBcuGR4hcM5nZ03Gj\nJtvmOhJd85o52nr6xLcODld/dgBYfav6irm7JSSyEZffE9YMQdcghEJKsGVZ\nJcv+WjS/DBcsOcBA8c3ZRu1Egiju0lgiaLQMRKM3izwrLvaLuf8Oa3DvpvYb\n7vhimM5kTye/heU9nrgkmsc0qabF1gZRJFKevYtLnAih0JScy94RBrJYN34d\nuugem+1oKtNe/qQrY6UjoIjxgRLI/ohz5gfpa3O/eeYRxE8eJU0x/ySQwAGZ\nTYFJ\r\n=Zu8F\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAyO+4I+ve+vHoRW2YeJt0fDr2EMSDCVRSsAOAEq1ZHDAiEA5FCkWt01doWYzpbQy6ycbwerFbdoTVbtSVUM9rWUV4Q="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.1-canary.91.cfc10bbe330aea82a07ea223c212af14fc582c5b.0_1614850396139_0.5002477906244764"},"_hasShrinkwrap":false},"2.10.1":{"name":"@sberdevices/assistant-client","version":"2.10.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"60ed8249db30a9a56c37ce7e7d5a8db3c508270e","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.1","_nodeVersion":"12.20.2","_npmVersion":"6.14.11","dist":{"integrity":"sha512-j1GZVTtbFpPHpt9bk7KVFtmihRQ9Bs2FJiwimJ57CWwaAIu9tByIdtMY1cGbmhYj5touEfVhLphYxUISxCcjbg==","shasum":"3f91aa05263388043f1e208fc7e86e40e1b574d8","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.1.tgz","fileCount":50,"unpackedSize":903153,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgQK62CRA9TVsSAnZWagAADRoP/3omY5v9UdrOS6gr756U\nVfp2U9sKDXh7JPpXTOHIqtnBB7am3VwG8KPaqX46KbAI9RohRNqBfOLlVXct\n62fR3X5czGC4SJC0e8dUgn0XOYSBVeM0EIt/EjOGXuHNerru+fQ3IxW7D4kF\n8FbmuVzN5rnyYvX5nl1iSjxcfddND7w1/TCFAv1H7pVCVHJuz97N2Z+VA2qa\nnZUZ5e+MHAOWoBSJIPzkHzyGXfjdRrxeqdFaGC6c/VvsJeVejhb/qvsotLp7\ndq2tTOALN8aa6pM71y72lPp+nk7laqiOdVGY9BYows+1BDwwJ0uGVZXdiwHX\nSOlvHEh0lbCVCxzI07RoYVfpBjsBhhjt8lTaj8IgCw8nZeDJiPSOVwjBJQKc\na2YXdIdxkT/9k/TE7u8wi5dquXODK01Wo03bD12sKyJnwbn9S99W9OBtuqDs\nNve00d42knwZPgiY2hC/kBGpwqJeLJQDbCJPS/+zDWsLbcAwZaWiWex1WT70\nqVsqTocZX8NQNgjDxFHkUyhBBMXAK8dmCOpNbiVL50qaZLqPLt+oBV2HQeqi\nOkffbRfrigeu0YqxzF/znwnFiGLw+HMFiyw8O9bjluDH72O86KtpHvLQUS+Y\n6DgGDTR/K9jc+QK7JdGztVnGJo9SX/bf123UBd4TYf6Yg707o80ff7vUXWwK\nqgc6\r\n=T99j\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCvwzNaFjrzJE2bJb2O+f8RhBtKZH4HyFscq9dYHVBMXwIhALD03Zxl9s0WwXGPsGsapylo/vr3lX2uMf4vpWIIkb3D"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.1_1614851766286_0.057317029478211046"},"_hasShrinkwrap":false},"2.11.0-canary.89.cfacfb8f79e8a8f8849c1c9bef0b66e08135c331.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.cfacfb8f79e8a8f8849c1c9bef0b66e08135c331.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"cfacfb8f79e8a8f8849c1c9bef0b66e08135c331","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n const clear = assistant.sendAction(\n { type: 'some_action_name', payload: { param: 'some' } },\n (data: { type: string; payload: Record }) => {\n // здесь обработка данных, переданных от бэкенд\n clear();\n },\n (error: { code: number; description: string }) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, позволяет передать обработчики ответа бэкенда и ошибки, полученной от бэкенд. Возвращает функцию для отписки.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nassistant.sendAction({ type: 'some_action_name', payload: { someParam: 'some_value' } },\n ({ payload }, clear) => {\n // обработка payload.data\n clear();\n }, (error) => {});\n```\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { type: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.type === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n type: string;\n // Любые параметры\n payload?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n smart_app_data: {\n type: string;\n // Любые данные, которые нужны смартапу\n payload: Record;\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { type: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.type).to.equal('done'); // ожидаем экшен data_note\n expect(action.payload?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным type, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.cfacfb8f79e8a8f8849c1c9bef0b66e08135c331.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-O2VjZwLtW48QOvy9ceoXL8J8lFduVQKYg+7qYf/MXWntq0v1vnGAkNttDlzbx3cdKf31bMHhpqMMWhShiIinsg==","shasum":"8253f0fb858d7d8d8a84c5ffcc6f5f1a9070d383","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.cfacfb8f79e8a8f8849c1c9bef0b66e08135c331.0.tgz","fileCount":50,"unpackedSize":909236,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgSKTyCRA9TVsSAnZWagAAskMP/j08qm58hNEJno70YkOO\noK0MCoXSxm5Vqz1bPE2Tzkp/d3brIp83/bwL41TJIpIcYnlRZ4+8ciczCpzY\nWubXeImEVqrEF0S0InRbznu84/owx1vZr9+QGi2MU82NdiovwBB9a6ucbhTA\nWONYa6oK8DyXMBB2v5mmESlVEx1jwn7aQpsYoG+GpPwkaKJSc1K5iCExGbGG\n/CqulkODHj6yWDO7tqQArTgNIPo+DERLslkd3u/NKWSWQ9MkyK1NmIvG4HtE\nK1q42umG8fRvJtLpyk85tArqlv3KR2p/jTGD3BuWw/0J0slGK3Ogvd5us3Og\nYow2yinvaKXyChV9sit7JRkYKsjvRlAYPB8U71WnJTkgtvlQO9SiX6rpmZpE\nlRjf1ssn2jVRwTif/ADrkxoib3akO+B93L+OvnXDL9z47XPyOmQu6K0Z5dt5\nv2bEFPXazX2AzfXZYup1qAmsziZ0O9od5O8w8EV2gtrt+4geOXrjr6KLGMPK\nOmlX+QjX2g4GBXt5ZM1VbaUoxT6lH6agQx6o1dSaxEx0rWQCTBJ7CtUm+GnF\nQelfe0OeOdFNd2YGTtzrzuA6Ilsk6Mrb92vYs47I/xaztEmrsh91N3GJc5nr\nxL5wXlLAqGGvFfGiEbq6xop5cN5JH9bCpw7IxbR9US4kKCBZt7n/sFWjzbK7\nxweQ\r\n=a+ZQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIARfpsIBlw/AdMWo2KSZqXX/h/uTefaUJLDV/JVxF2rUAiEAwrEAhkLRm/hTdAFTD9yltlM4ACV2+8UaHFvlgBGyEHQ="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.cfacfb8f79e8a8f8849c1c9bef0b66e08135c331.0_1615373554247_0.45653015931736185"},"_hasShrinkwrap":false},"2.10.2-canary.94.e2aba4c1fd45236de4a74d9290728f78790087b5.0":{"name":"@sberdevices/assistant-client","version":"2.10.2-canary.94.e2aba4c1fd45236de4a74d9290728f78790087b5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"e2aba4c1fd45236de4a74d9290728f78790087b5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.2-canary.94.e2aba4c1fd45236de4a74d9290728f78790087b5.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-HbCROkly8sflqcTX7o7b0xWWChVcNoE3qAV0PNiKRZMctCNUdSa8mouExyHW5ocW6Qp7HDhuYvm4SVcQ7JBG1A==","shasum":"03d682974b664f8498b84d1eeeae6645e4b456ad","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.2-canary.94.e2aba4c1fd45236de4a74d9290728f78790087b5.0.tgz","fileCount":50,"unpackedSize":903734,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgSLt0CRA9TVsSAnZWagAARJQP/i8ansIkoyEbEtzu8oDW\nGd1sJEu2IUWYhzKfJwAdpjoinHHe6bwBWUNxgsMH+RfkpxYqPvZxbiLKvMMu\nsoqAtAzJTL9mQ1t5QXzyf8ocCj3+81U2mFPqbQ10ShK38Y/PAmIki3ZsMYr9\n/ZX29lQOPWGt+MAUPSP4novOrmw+FfQHs0RxyMnpYsSIhmj5hBdETdgqT5uL\n04yXnj5HlhFnIyvSYhoxrbY3mSBr0PTMETA+wU08whgvp/TG90xG7OB7mHrT\nSnWr3XkjnUDHFYwgOFECh9cDPbj2hJCRISNkFW1MlzFxSyrFKeu8KIksUPCJ\nThC75u+w1dcXdUseMa0K/ocVvIVxrZ+cGyOIKLO6QCFG2SdQxX1AMy9Wjr7m\n6t5boNOWYZCocuM3/kVI74eU6RcTEZEVtaSL3mrV/mFMq1ZWuuEoJEi7uZrT\n8H1qGbNCvbEHFoRha5TBXCyiqtRH1Ndh7mkkLmVX1QBvWcs+N6O1TKpUQQBv\n1o4ZBB7WTJVM11a7QuymKdqE6ri0xRyNVhO3eQIHr4mCFqd7q4TTa3jWGG3O\nJmK3FV3cURjsveOayEASHvRAXVn74pW6mleZAUDswI6OIZHnEEdb7dd8d79F\nSgcKGdMWtxGxlVM7wGMjuQoqJ6hzwIw7AIdC+Iu8zV83XQXPnaJhaqCM3wna\nXnHX\r\n=urSS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBtKyLtMKrm6CbJXrmcF/WwCsfBSvoEwBnM+EaoziSKaAiEA7xYhooJ5wRToJRbbFx8qxUSzHGNJrVFBu2Z96ez67jI="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.2-canary.94.e2aba4c1fd45236de4a74d9290728f78790087b5.0_1615379316047_0.8072311476619232"},"_hasShrinkwrap":false},"2.10.2-canary.95.edae68dab6bcc09110684fb6442efd93361c797b.0":{"name":"@sberdevices/assistant-client","version":"2.10.2-canary.95.edae68dab6bcc09110684fb6442efd93361c797b.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"edae68dab6bcc09110684fb6442efd93361c797b","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.2-canary.95.edae68dab6bcc09110684fb6442efd93361c797b.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-Zr386xVm5Fy7sNdhSi7lHMknvkU/I9IljmlLXnTqzGYMST01DeffQ0kmcLDVbmMlYmxsrdmSMFfyCMLohGLbtA==","shasum":"a276e55758bdb1fd701babd3e95fabc8a25dd520","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.2-canary.95.edae68dab6bcc09110684fb6442efd93361c797b.0.tgz","fileCount":50,"unpackedSize":903492,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgSezLCRA9TVsSAnZWagAAwiQP/A8b3YZxKU49tPwpZ9NV\nkacdr6XcBbxqrayFF0SgKhx98YB3LozWNt9IPxkco+gS7Qvcxwv9slJu+5nX\nj9+ZbYM2QLKBlgkd3zqpAB+7b5lGMPC1Upho5L5qcCXzzIHDD2iOEyaQ/qmz\nl2s2rFI3/rQTXQOsRqG4G3zA8rW/JL5FCBemiEgzrS9kevHDWMwgtZ+KeP/2\n6SRsHBRDWP6eZ2MDZsRejX2OYe7O+a82e8AloT5mgxqVainqJMRapsT0J3l/\ns/OSmjQP2Sx5SW2IiQjoCCVRnMwLKCWQUy4lXP56L+kygUEXDAKmf2e8slWC\nm+N9PrhRbNLQExCr3MYuQtUBUXvDJW75UeTe+RboV8Fk66tA4cuuQLYGwKG5\n0SWkxMdmi/BBcE5E3ZgBGcbwqQlYa2KADNhZ+TosPmy8hpbuV50BO+TExCdm\nxggDfJESoJcQ+mIzhxALSPld65VccgixKYJhYqEHf5day1HGZulUWm2s+EGe\nP8q++44gNt/Ew9/XSAdkXXEUatQjCXxn/Abqhg5CBAA1b7AuuVls6/rPhkDQ\nnCWi10Qf1sVyJJYLOBA5ZLTpNOTNE0GJAXQA/0NTR7wfSfWblZYwmKnY7xV8\ne2IV6fMbz3D6cdjB8JYyC5z1h7QgUXwE8KFwBgt/UbuTg5fLPk0IFVPBMpoT\nvrPj\r\n=J67E\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD1Cfn3biMGB2KfwZb/SItmGb0Kv3dXYzgCVjEFXm2wzQIgIdBZEwOe+j4/ANwpSqiikSMOzzmp7cjz493b9NuODrc="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.2-canary.95.edae68dab6bcc09110684fb6442efd93361c797b.0_1615457482718_0.9327795022960321"},"_hasShrinkwrap":false},"2.10.2-canary.95.c4a4d28bef2a4aacf3a3669be9675e66f99582e5.0":{"name":"@sberdevices/assistant-client","version":"2.10.2-canary.95.c4a4d28bef2a4aacf3a3669be9675e66f99582e5.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c4a4d28bef2a4aacf3a3669be9675e66f99582e5","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.2-canary.95.c4a4d28bef2a4aacf3a3669be9675e66f99582e5.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-Ap42O6zB/+kUD3rSAeyGoRHBGkjlducdBGwztjEjngkefkIjZKNyXG6D6pb9gVWrYLylifAJ9t/aT1BhptiopA==","shasum":"f671b11ceacc48e046e0c58872e8608ed073e76b","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.2-canary.95.c4a4d28bef2a4aacf3a3669be9675e66f99582e5.0.tgz","fileCount":50,"unpackedSize":903628,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgSfH4CRA9TVsSAnZWagAAr70P/0lOiOU7f86fSfvjPr+d\ntj/Ovczld72TbaWk4oQqz7i17CVeWmlzQnkkkrMKB2wlOusd36bzuzhO1v9W\nvDUheJwK9ypT3HFiUcWOr/xXBKsBnfSowRhgSjMQM985x8aIagV97gKW04PJ\nIPczT6K++s2wICMJPn6VJX4G4iotMnqxlMVU9eh47ico/j3dT6kzPro1c08e\ntH9cVX7SroG1106lj1RzBu5VQHpE8VPE278kIfUbo4QXpB1vkaLfSvUG9aXZ\nLJZyn/2ErFLhNXnzuYPIdevK1GHSuEJPyQwGd0l9h/Gzj5oKIdHHBdDzfNQh\nnmks0pMnqdDH5320wvtlE49LcQvq2rKRgKpAzlTS9p47YZPFeIBilJhlTbTr\nggGsSlfXRj/qKTaeSshaZo41ZO6NPbQcdSBSQFVruG43ZrCxvESXwx7GPmRk\nEy3zPyQXvC9fKGWqRBbSX8G52Imw/TiXIdW4nJg/CM0yZp60475lrLtQT9Fs\nDfPP+9/Q5mUreOyY7lUqQVKqa5jA1QBbol1huSPycJrFtEE7hdLsOSjDBZb1\nWsIyndsNSnCk0n0hG9ySXXqaoFnLZbr2JlRLMhci8UTD+PJudSAbzWT0pIJs\nDHC1BeZokQAk9asR7Kvc4QaffrFZZXzUb2Qi+LXgSO1ES5R4n/IJy8K1o1it\n4HUK\r\n=PgeL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAMReugVyUk1bxETYMBjNwaIXiQ9Q8XupKCFJ9tQ3fEVAiEA795scnl3D8Vje9hymkTFP/YbdMPOGaUxiaUmHrXCHdM="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.2-canary.95.c4a4d28bef2a4aacf3a3669be9675e66f99582e5.0_1615458808069_0.8865935248481347"},"_hasShrinkwrap":false},"2.10.2":{"name":"@sberdevices/assistant-client","version":"2.10.2","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"8dd260aa8f717fbd14df5da531e9c037aa17f838","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.2","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-KDKs7rqZvB27lk3gCC/DtyvNW9AZe48m2RJ972Fy50Tk/XyXPNuAeUzcdyXoL6QbBXvr3QGOPG4sUBLpqk7YHQ==","shasum":"2caed46f10c8c02ba82b1ee3c51be5b08b1f4773","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.2.tgz","fileCount":50,"unpackedSize":903928,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgS11QCRA9TVsSAnZWagAAIV0P/2h6aUImI+gNnszEhDZE\n2NUsRffdIcaI8o0durE6gHGRg8/rm9bAIN1KUiX7O/X8LG+990fZkNxa51zP\noGli0C5WsbW/Dd+NhGv5NiSQ8Q8NHE+XK81NIKEO6ztVk7BdsNfupSrOVFkz\nNuMfMcS8Tu1Bior6Tk7mL7hcqW5oItYKGICrPUPiBk03oH/730NzIHKtu6nB\nMvxSSO8WaV9C+RxNP0FBs1QcNQGyk7XmgWVFeJhRUgvix4QtpR26bnuDbGCl\nLVJAdUAtkxV0XMpVwcyuA74vjFArz+B1McO+/e4/E0XDGByKcwoL5fefbKir\nPiVQkIfg5SaYvGmDWqc8JXAIRE4IbATlaEgAK5pMPc7cbLgru7bkvktu2UaK\nHucdLMLeCsmeMaiHCBshaqNyazObbU0pv/tEPReuZpdkb0mz60NRrB0r04I9\n1B+qiLkLS5ROC01/vDEh7Q3zDjeM72of63rjH1ItZSZWCcrlxu4Zt8F08QOw\ntgAjkigz8l50BYoTvrsHMZsPH58x7pkzXptcjTG59izvYTb30cXCOFIqr+Cq\nWqhiCo+j+CoKbWVTl1v1CjQSKnbd/XVTewUoF1pJo4gCQbvPRBp9XwK7fkSx\nL+91rD2d8moT6aEepYmdNBbSDhUdyMrUNANCvkzZ6/KviLBgCAmGz9rH7u5Z\nyj6d\r\n=JZhL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC8XQ38ljp4W0GGCnc3fNqFYZj3f47Pp196x1ANQkxjdQIhAJJ0pKgPAzGEyeaqxYPfjMpMOS+mvLFIdn45ENlIAM4j"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.2_1615551823772_0.15268144195874944"},"_hasShrinkwrap":false},"2.11.0-canary.89.74a3bf7281113c9de2365bc5307ecc768e0f5167.0":{"name":"@sberdevices/assistant-client","version":"2.11.0-canary.89.74a3bf7281113c9de2365bc5307ecc768e0f5167.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"74a3bf7281113c9de2365bc5307ecc768e0f5167","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n const unsubscribe = assistant.sendAction(\n { type: 'some_action_name', payload: { param: 'some' } },\n (data: { type: string; payload: Record }) => {\n // здесь обработка данных, переданных от бэкенд\n unsubscribe();\n },\n (error: { code: number; description: string }) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, позволяет передать обработчики ответа бэкенда и ошибки, полученной от бэкенд. Возвращает функцию для отписки.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nconst unsubscribe = assistant.sendAction({ type: 'some_action_name', payload: { someParam: 'some_value' } },\n ({ payload }) => {\n // обработка payload.data\n unsubscribe();\n }, (error) => {});\n```\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { type: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.type === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n type: string;\n // Любые параметры\n payload?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n smart_app_data: {\n type: string;\n // Любые данные, которые нужны смартапу\n payload: Record;\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { type: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.type).to.equal('done'); // ожидаем экшен data_note\n expect(action.payload?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным type, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0-canary.89.74a3bf7281113c9de2365bc5307ecc768e0f5167.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-ZOI93jtdtSpNjwIGIXjfmWTrDLr4Id5pTWTiC+Aj7W4TVhxY8jyeo64NYWjXz3anz9k12WpB/zZ0KRVaPBvvww==","shasum":"923efa3833ce6ae1a72a4ee324a42cf648446b84","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0-canary.89.74a3bf7281113c9de2365bc5307ecc768e0f5167.0.tgz","fileCount":50,"unpackedSize":910042,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgS2dmCRA9TVsSAnZWagAAkrIP/2XQOUwYumX7ZAMXgM6Q\n3ulJx0rG0K0X2Un4EEjpbJvfmiwHPK5HobYv77ETu/BQZq4DF9mesI2hBlYJ\n5/cL6e8sslrdaUPrJTrYIAl1gcEa0bHyYG4kY+phGvuxNmysFJnz5vwGGyuR\nTAeveUR6+/mvB75qAuSUMWBna6FfVdDTJ1Q82wBATubQilOUf328UpalDiTo\n7DjLI64ps88s17DzRaQyA8qA2UXTsO2zR6d2pmOzjhLsZC3Y2bpTpz5BqW6b\nYTU+vRQdFsz5PSwSeuen+07atk55yycMo1vKbhIf8G4wLKT3/9tnUP1XLuP3\nyUsk2gzhLqiFYj1+cGOYujdR3wGgdN/zDYgIR2AJaotIZU2nYKKId7KJ7S81\nZp+6+DF8YPfnoZK9QJma6nhiz9k+AzNvgQJ3TX1mYCoOlHr/zIfTYOmVNE4j\nPNOzagxitAbh7vdq27f8osWEQlI6KhScqkNkQnS0FqBLLS9HoN1HKDS91mW2\nCCHdxlNnreUKiWa+Ao32gvWv6dr9IV5zDdX2/RwLzsNxgfYDCoYtwgXywBiM\n5b77GSVxQ1Opds+8UZ8LnXHYDhWpi25Jen/AziBQhXRP+NXQHeYapbsGoNu8\nriVzNIes4cDbQi24fGKGioag6CSvZyxe1GXNf7EMkpUbQOY2sdYQ7LBC2bPW\nq6ub\r\n=304W\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBdAwyoRoGlmI6iDoohG+DqyYSVvz+YKN8UpHgi13geOAiEA7ClmBhtReS4Wm1GMZ8ouAFkScby2fNPrr5RSNQ59jV8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0-canary.89.74a3bf7281113c9de2365bc5307ecc768e0f5167.0_1615554405427_0.44138213053056563"},"_hasShrinkwrap":false},"2.10.3-canary.95.a827465636976d0d4bc61a8bd356048f4186b1cb.0":{"name":"@sberdevices/assistant-client","version":"2.10.3-canary.95.a827465636976d0d4bc61a8bd356048f4186b1cb.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"a827465636976d0d4bc61a8bd356048f4186b1cb","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { action_id: 'some_action_name' } });\n};\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { action_id: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.action === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n action_id: string;\n // Любые параметры\n parameters?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n // Любые данные, которые нужны смартапу\n smart_app_data: Record;\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { action_id: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.action_id).to.equal('done'); // ожидаем экшен data_note\n expect(action.parameters?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным action_id, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.3-canary.95.a827465636976d0d4bc61a8bd356048f4186b1cb.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-uC9Du1BkEtxue1WPXq1XVTtuTMajVE5pM+VPeryjlvkADr8SAXUIiVdYscUe8TLuA2XYHZSgTUB4f2Sg3F8Hbg==","shasum":"5112fb8d4ec5506571260252ea0698970a58050e","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.3-canary.95.a827465636976d0d4bc61a8bd356048f4186b1cb.0.tgz","fileCount":50,"unpackedSize":904423,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgS2f6CRA9TVsSAnZWagAAlBYP/1xKj2jvInKDiHQiUV1h\nQ+ZFeOZoMhOhkttqKUHZdjc+QtfGuIG5UOUijXTqZlTAWQH3Uxcl3gUTFOzS\nG1Q3wFr+j8WnyQbwXM/7lISxnlyLmi1EO85hMfj6Vs2mAuYKQ+D3k2kIq9X9\nDPT0mCBbKegzyYEOMqhX+Tq8y728GWqsP48MlyaveVJXAePTbMANj1jUjQvd\nH9pCyCxJ8KIeFHfs/LNKt7R6v/6WLh0xT6W0xen2oF2G19aooY9uxwEPdapG\n19+JGOWb+flQXBD7gphSFTSpO/TTG4FHo6DGou4j8dIwuZS0bq/O+WWYG+yP\nUHLltMeOR6CB1aHdaoc6EnO1I/WoENO2v+HfOv2UxFKCA89U3DiFLcVdB+DG\n9lR/Z1/aKhzNTidTmSPL5Ttcm4xFIUeNk0e0vLM+CmOQFk5FxMnlmX8HWaoo\nTzV2M/hldIScZthXMudTB+j/1VWhZj3iswRDPrjV2FRbkgJdETA5yLlUKe1X\nHzHgPer1I5soQ5jh+Z8RS8LnJsYji5f4tGXz8o/63GBjKttkDDdtiULskaZB\nA6HnLSvrHHwow/bLoDuyzSRBucXBwciccHpFsRjjHVQDCRw14sEo6uRFTkCM\nLAAKozxmfyoJJtoTuTczLDKfgPLdRJDce1SCRnoJxpcJS70qUoWPz/br3Qxj\ncK5b\r\n=1DWH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGfMqrsgtbk46ggP9fsXbbBvkHP8iHci+laA5o3KAQl5AiBtLgCadIIs5wfNUcIqqNGP7aoVWYnktOGp9Gi5NWMEsw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.3-canary.95.a827465636976d0d4bc61a8bd356048f4186b1cb.0_1615554553218_0.4781493270396162"},"_hasShrinkwrap":false},"2.10.3":{"name":"@sberdevices/assistant-client","version":"2.10.3","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx .","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"76aaeb042accb554912620a167d334fc6cb1eeda","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.10.3","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-PhKeyKleNAbzkNzFv5FM5EZVrTiUPsDlDQOTGPkEqgZXw2+kBlS7jEWOdgqolfohjvZaD+CthRMcTkCOedtTdQ==","shasum":"1f0c233ce0df9e368b30181f3260be96a38de07d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.10.3.tgz","fileCount":50,"unpackedSize":904815,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgS2miCRA9TVsSAnZWagAAJU4QAIODxE8pqZt8OLNTZGKV\nuODTQF/YUpQstgurblY5GGZnuXTZGa+mGJyjTI6LzGSSHC6Q4c0Kq/az8LUj\nuKB0lNWN1hYAtFtVCTSmJBavbfuMeV+Ogjg9UoC6ynmjaZxwkwnwW/IsnWHv\n3k4j345WjSUfQLIBPxF98ZstJxPZ1wY2qHzi0pWUdnrGNtq7zPoZiZ4YgYNi\nVIpnBckMfqIUysVGlMGTVMoTwwS0fwF0gCI7mSyMkpS5YLmLGqGFXLGHK2Rv\n9gUNHLNIfzJvsvuNQbGybiLG+1M53wtLx9elfWMu+N9aV+zPEVpHji2o6rHd\nGRxtULVKorMRM09ujR+tiK/ThJZ0TPi5H4RjSdugDNUeacdd404ewXi4Y3sh\nAa07oY2k8HHI4F+NhQaCP3ZJtDfGDa9/g963y3UXvaW6fx/BKTyEI5b45iW/\nlLteNdiWTFoComx4bnGs9ZmRbgIHFk7H+2iJNohkHeF7ZY6RSnSlBSWO8En9\nZzYNSpXfXRQohFm7MVG0V5qrtU3GqmwxuV8kc1mK/XghS3H8KLGTTfzXAlxy\nQDB8hWRnImjQASMeKRWYsN5mSNq3EQhX/iBU8+jUwnuFlDgbQd1cl2UDHspZ\nsQCvfm0rJ6c7DnPMlQ8gM85JigKVXFuh61i+mSFnIaccri/isF9dSnBgX295\niRSG\r\n=oHqK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBebPU24/tLw5Q/QI3fyofRXBjZFd0hiAez7QGWnwgD6AiBWEi6TjlECILCwytZdnrHe3DlBe57aFQkPAI+3LqAvNw=="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.10.3_1615554977703_0.2760354889661676"},"_hasShrinkwrap":false},"2.11.0":{"name":"@sberdevices/assistant-client","version":"2.11.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"095a9140693a9a5dce613228ee2b4e45e192b257","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-UGWxDcMqkiVzFJGFLgcuqMO3jR7fF3W3rZuwq3OQVz3PZKtB4uM8tKQPg7IMZIz6+CVSYGFvn4RFj7O3fbyCcg==","shasum":"44e49a5c597a1c2c61f1611381ff1316482e0241","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.0.tgz","fileCount":50,"unpackedSize":911379,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgTxY+CRA9TVsSAnZWagAAH5kP/30yooe7snYOZVGBKM6E\najp9IQpUVyl4x/B1bGXtKAHuk2ZooOi+72rNVUbkNccccVOEJJmKfdstA0BQ\nyk6lgzKEgedmNMUzEeqWxdfSS2oiScuMRrOEf3Jez7f8UN975i0NcLepSMii\nNJQ+YFjPrTeSTmTkg8WBvmAbOyuLRWXORJLmOmG2K/5k60fCO90XfvWuLsob\nmwSwUzNoOw+jz4xEoAg4Vj6dHtm4W1+A8x4sBIMZfCgs9l9ORePQSdVUvqwe\nviEIJHeV+zWq7DtfrceM5u/p6iLsjB8mmQvWWtHPSoW4kZH7FETtg35cCMjl\nNGZqBqjWZtHSsLVDlR3xCT2O0f9ooAdiSfcH6dr3v44WpXjk1f+wWdM0gUBe\n5PSlMPuJbu9CJpFcxdHy4Lpml7b9KAqrbzT6c04obs49pGAHQ2pJTcMBIiYl\ntUNcYJ8EQoTmebYhZMZw8g5ITbQYkF+QFfjm0rZbs85n8L8YP9RUprgvV9Y6\n6gWbPmD8mtokabxyfXzxjh5tXvZc+C9s1GVlvtHjS8CBWcXMUdkUGYChTQM8\ngTGs2yYnNasE5myHdDqWMECBIr/NbERybW0ZDBUaS1qPusf+eFbyDDloh7wj\nAAsE2EHIf7SNpW/XrU+0jFJej3zezJiNXQgGsM11YmZVDYfO0yZ+J1yo5PJw\nhf9d\r\n=xZv6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEicRCwi3CC/zXOWhLwhpyQJ/QXUUBiORHjZ2PERP1GrAiEAi686r6Q5jPCLp4oo/GIOYNyGQ+qNL+ZSHt3/YAG0j5Y="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.0_1615795773819_0.17964367535976633"},"_hasShrinkwrap":false},"2.11.1-canary.96.c2d5e659995d90bbec3ad6edd1a43757f0b52931.0":{"name":"@sberdevices/assistant-client","version":"2.11.1-canary.96.c2d5e659995d90bbec3ad6edd1a43757f0b52931.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"c2d5e659995d90bbec3ad6edd1a43757f0b52931","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n const unsubscribe = assistant.sendAction(\n { type: 'some_action_name', payload: { param: 'some' } },\n (data: { type: string; payload: Record }) => {\n // здесь обработка данных, переданных от бэкенд\n unsubscribe();\n },\n (error: { code: number; description: string }) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, позволяет передать обработчики ответа бэкенда и ошибки, полученной от бэкенд. Возвращает функцию для отписки.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nconst unsubscribe = assistant.sendAction({ type: 'some_action_name', payload: { someParam: 'some_value' } },\n ({ payload }) => {\n // обработка payload.data\n unsubscribe();\n }, (error) => {});\n```\n\n#### sendData({ action: [AssistantServerAction](#AssistantServerAction), requestId?: string }, onData?: data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => void): () => void\n\nОтправляет события с фронтенд на бэкенд через ассистента.\nПервым параметром (обязательным) - принимает данные для отправки.\nВторым параметром (опциональным) - принимает обработчик ответа (на переданные первым параметром данные); в этом случае - в on('data') ответ не придет.\nВозвращает функцию - вызов которой отменяет обработчик ответа.\n\nПример с обработкой ответа:\n```ts\n...\n\nconst unsubscribe = assistant.sendData({ action: { type: 'some_action_name' } }, (data: command) => {\n if (data.type === 'smart_app_data' && data.smart_app_data.type === 'target_action') {\n unsubsribe();\n ... // обработка команды\n }\n});\n\n```\n\n#### setGetState(nextGetState: () => [AssistantAppState](#AssistantAppState)): void\n\nПодменяет callback, который возвращает актуальное состояние приложения.\n\n#### setGetRecoveryState(nextGetRecoveryState: () => any)\n\nПодменяет callback, который возвращает объект, доступный только при следующем запуске приложения. Данные приходят при вызове getRecoveryState.\n\n\n____\n\n\n## Форматы объектов\n\n### `AssistantAppState`\n\nОбъект `AssistantAppState` — текущее состояние смартапа, которое не хранится в платформе или сценарии. Каждый раз, когда пользователь начинает говорить, Assistant Client вызывает getState, чтобы получить и передать в бэкенд состояние экрана пользователя.\nТо, что происходит на экране у пользователя и как он взаимодействует со смартапом в конкретный момент времени - ответственность смартапа. Assistant Client в данном случае - это буфер, который только передает состояние платформе или сценарию.\n\n\n```typescript\ninterface AssistantAppState {\n // Любые данные, которые могут потребоваться в бэкенд для принятия решений\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n [key: string]: any;\n item_selector?: {\n ignored_words?: string[];\n // Список соответствий между голосовыми командами и действиями в приложении\n items: AssistantViewItem[];\n };\n}\n\ninterface AssistantViewItem {\n // Уникальный (в рамках items) порядковый номер элемента, который назначается смартапом\n number?: number;\n // Уникальный id элемента\n id?: string;\n // Ключевая фраза, которая должна приводить к данному действию\n title?: string;\n // Фразы-синонимы, которые должны приводить к данному действию\n aliases?: string[];\n // Проксирование action обратно на бэкенд\n server_action?: AssistantServerAction;\n // Выполнение действия от имени пользователя\n action?: AssistantAction | { type: string };\n // Дополнительные данные для бэкенд\n [key: string]: any;\n}\n```\n\nНапример, когда пользователь говорит \"Покажи 1\", бэкенд должен понимать, что скрывается за единицей (то есть, какой элемент у пользователя пронумерован этой цифрой). Ниже пример состояния, который позволяет понять бэкенду, что, называя \"1\", пользователь хочет чипсы.\n\n```js\n{\n item_selector: {\n ignored_words: [\"покажи\"],\n items: [\n { title: 'Сладкий попкорн' },\n { title: 'Соленый попкорн' },\n { title: 'Чипсы', number: 1 },\n { title: 'Начос', number: 2 },\n { title: 'Кола', number: 3 }\n ]\n }\n}\n```\n\n### `AssistantServerAction`\n\nОбъект `AssistantServerAction` - это любое сообщение, которое отправляется с фронтенда на бэкенд. Оно может быть привязано к ui-элементу и приходить с бэкенд, или формироваться самостоятельно фронтовой частью приложения при обработке событий внутри WebView смартапа.\n\n```typescript\ninterface AssistantServerAction {\n // Тип Server Action\n type: string;\n // Любые параметры\n payload?: Record;\n}\n```\n\n### `AssistantCharacterCommand`\n\nОбъект `AssistantCharacterCommand` - информирует смартап о текущем персонаже (Сбер, Афина или Джой). Персонаж может быть изменен в любой момент по инициативе пользователя. Поэтому разработчик может дополнительно добавить обработку таких изменений.\n\n```typescript\ninterface AssistantCharacterCommand {\n type: \"character\";\n character: {\n id: \"sber\" | \"eva\" | \"joy\";\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantNavigationCommand`\n\nОбъект `AssistantNavigationCommand` - команда навигации пользователя по смартапу (например, \"вперед, назад, дальше\" и т.д.). В платформе виртуального ассистента есть стандартные фразы, которые приходят и обрабатываются одинаково для всех смартапов.\n\n```typescript\ninterface AssistantNavigationCommand {\n // Тип команды\n type: \"navigation\";\n // Навигационная команда (направление навигации)\n navigation: { command: \"UP\" | \"DOWN\" | \"LEFT\" | \"RIGHT\" | \"FORWARD\" | \"BACK\" };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n### `AssistantInsetsCommand`\n\nОбъект `AssistantInsetsCommand` - команда, которая сообщает смартапу о том, что поверх него будет отображен нативный UI и его размеры.\n\n```typescript\ninterface AssistantInsetsCommand {\n type: 'insets';\n insets: {\n left: number; //px\n top: number; //px\n right: number; //px\n bottom: number; //px\n };\n}\n```\n\n### `AssistantSmartAppError`\n\nОбъект `AssistantSmartAppError` - это уведомление об ошибке.\n\n```typescript\ninterface AssistantSmartAppError {\n type: 'smart_app_error';\n smart_app_error: {\n code: number;\n description: string;\n };\n}\n```\n\n### `AssistantSmartAppCommand`\n\nОбъект `AssistantSmartAppCommand` - это команда передачи смартапу любых данных с бэкенд.\n\n```typescript\ninterface AssistantSmartAppCommand {\n // Тип команды\n type: \"smart_app_data\";\n smart_app_data: {\n type: string;\n // Любые данные, которые нужны смартапу\n payload: Record;\n };\n sdkMeta: {\n requestId: string;\n };\n}\n```\n\n____\n\n\n## Пульт\n\nДля получения и обработки нажатия клавиш пульта сбербокс необходимо подписаться на события нажатия клавиш клавиатуры. Пример ниже:\n\n```javascript\nwindow.addEventListener('keydown', (event) => {\n switch(event.code) {\n case 'ArrowDown':\n // вниз\n break;\n case 'ArrowUp':\n // вверх\n break;\n case 'ArrowLeft':\n // влево\n break;\n case 'ArrowRight':\n // вправо\n break;\n case 'Enter':\n // ок\n break;\n }\n});\n```\n\n### Навигация по страницам приложения\n\nДля корректной обработки кнопки `back` и навигации по страницам приложения - необходимо строить историю переходов, используя `History API`. Например, подписываемся на `window.onpopstate` и реализуем изменение страницы в обработчике этого события; когда хотим выполнить изменение страницы вызываем `window.history.pushState`:\n\n```typescript\n\nconst [page, setPage] = useState('previous');\n\nconst handleNext = () => {\n window.history.pushState({ page: 'next' }, ''); // инициируем переход на следующую страницу\n}\n\nuseEffect(() => {\n window.history.replaceState({ page: 'previous' }, ''); // устанавливаем текущую страницу\n window.onpopstate = ({ state }) => {\n setPage(state.page); // выполняем переход на заданную страницу: next - по вызову handleNext или previous - по нажатию кнопки back\n }\n}, []);\n\n```\n____\n\n\n## Утилиты для тестирования\n\n### Имитация команд ассистента\n\nДля имитации команд от ассистента реализована утилита `createAssistantHostMock`. Ниже приведен пример использования, полный пример можно посмотреть [здесь](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app).\n\n```typescript\nimport { createAssistantHostMock } from '@sberdevices/assistant-client';\n\nconst ITEMS = [\n {\n id: 1,\n title: 'Купить молоко',\n number: 1,\n },\n {\n id: 2,\n title: 'Купить хлеб',\n number: 2,\n },\n];\n\ndescribe('Мой список дел', () => {\n it('По клику на чекбокс - ожидаем экшен \"done\" c заголовком выбранного элемента', (done) => {\n cy.visit('/')\n .window()\n .then((window) => {\n const mock = createAssistantHostMock({ context: window });\n const selected = ITEMS[1];\n mock.onReady(() => {\n // эмулируем инициализационную команду от бэкенда со списком задач\n mock.receiveCommand({\n type: 'smart_app_data',\n action: {\n type: 'init',\n notes: [...ITEMS],\n },\n })\n .then(() =>\n // ожидаем вызов assistantClient.sendData\n mock.waitAction(() =>\n // эмулируем отметку выполнения пользователем, который должен вызвать sendData({ action: { type: 'done } })\n window.document.getElementById(`checkbox-note-${selected.id}`).click(),\n ),\n )\n .then(({ action, state }) => {\n expect(action.type).to.equal('done'); // ожидаем экшен data_note\n expect(action.payload?.title).to.equal(selected.title); // ожидаем в параметрах title экшена\n expect(state?.item_selector.items).to.deep.equal(ITEMS); // ожидаем отправку списка в стейте\n done();\n });\n });\n });\n });\n});\n```\n\nВызывать `createAssistantHostMock` только при использовании [`createAssistant`](#createAssistant). Например, при использовании cypress, функция инициализации ассистента может выглядеть следующим образом:\n\n```typescript\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initializeAssistant = (getState: AssistantAppState) => {\n if (process.env.NODE_ENV === 'development' && window.Cypress == null) {\n return createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n });\n }\n \n if (window.cypress) {\n window.appInitialData = [];\n }\n\n return createAssistant({ getState });\n};\n```\n\n#### addActionHandler(actionType: string, handler: (action: AssistantServerAction) => void): void\n\nПодписаться на экшены фронтенда с определенным type, переданным первым параметром.\n\n#### removeActionHandler(actionType: string): void\n\nОтписаться от экшенов фронтенда.\n\n#### receiveCommand(command: AssistantClientCommand): Promise\n\nЭмулирует команду, полученную от бэкенда. Команда придет подписчикам `AssistantClient.onData`.\n\n#### waitAction(onAction?: () => void): Promise<{ state: AssistantAppState; action: AssistantServerAction; name?: string; requestId?: string; }>\n\nВозвращает `promise`, который будет разрезолвлен при следующем вызове `AssistantClient.sendData`\n\n#### onReady(cb: () => void): void\n\nПодписаться на события готовности утилиты, cb будет вызван по готовности к работе.\n\n\n### Запись лога сообщений между ассистентом и фронтендом\n\nВ режиме разработки есть возможность записать и скачать лог сообщений.\nУправление записью осуществляется кнопками start и stop, кнопка save сохранит файл с логом в загрузки браузера. Пример активации панели управления записью лога:\n\n```typescript\nimport { createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst assistant = createSmartappDebugger({\n token: process.env.REACT_APP_TOKEN ?? '',\n initPhrase: `Запусти ${process.env.REACT_APP_SMARTAPP}`,\n getState,\n enableRecord: true, // активируем функцию записи лога\n recordParams: {\n defaultActive: true, // включать запись при старте приложения (по-умолчанию = true)\n }\n });\n```\n\n### Воспроизведение лога сообщений между ассистентом и фронтендом\n\nПример пошагового воспроизведения лога сообщений, входящие сообщения, от ассистента, будут последовательно переданы подписчикам AssistantClient.on('data').\n\n```typescript\nimport { createRecordPlayer } from '@sberdevices/assistant-client';\nimport assistantLog from './assistant-log.json';\n\nconst player = createRecordPlayer(assistantLog);\nlet end = false;\n\nwhile(!end) {\n end = !player.continue();\n}\n```\n\n#### continue(): boolean\n\nПередает следующее сообщение от ассистента в AssistantClient (может содержать несколько команд), возвращает флаг наличия в логе следующих сообщений от ассистента.\n\n#### play(): void\n\nПоследовательно передает все сообщения лога от ассистента в AssistantClient.\n\n#### getNextAction: { action: AssistantServerAction; name?: string; requestId?: string; }\n\nВозвращает следующее сообщение от AssistantClient (вызов sendData) в ассистент. Можно использовать для сравнения эталонного сообщения (из лога) и текущего в тесте.\n\n#### setRecord(record: AssistantRecord): void\n\nЗагрузить указанную запись в плеер.\n\n____\n\n\n## Требования к устройствам\n\nСмартапы должны корректно отображаться на разных устройствах (SberBox, SberPortal и др). Для этого необходимо проверять смартап на следующих разрешениях: 559x568, 768x400, 959x400, 1920x1080. Настроить эти разрешения можно на [вкладке Devices Chrome](https://developers.google.com/web/tools/chrome-devtools/device-mode#custom).\n\n____\n\n\n## FAQ\n\n### Не работает озвучка и/или микрофон в браузере\n\nНужно перейти в [настройки сайта](https://support.google.com/chrome/answer/114662) и разрешить доступ к звуку и микрофону.\n","readmeFilename":"README.md","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.1-canary.96.c2d5e659995d90bbec3ad6edd1a43757f0b52931.0","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-cGhjsC3QX2c+8JvdC4C47oBudCig48/M+l3Uv4NN5+rgpG3Wljv4MKsYf0sdF6bY1u8U/uN6UVVVjE1V1CGduQ==","shasum":"b33e8465a5efa9aad516427b42e836793b4da791","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.1-canary.96.c2d5e659995d90bbec3ad6edd1a43757f0b52931.0.tgz","fileCount":50,"unpackedSize":911680,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgT5QvCRA9TVsSAnZWagAAM8oP/0wf04hNA8Ly+DXKFP3p\nyDqGOyexhFoJPQMMH1dyKZQklMKuMCdZqfCThsdZUdY9ItS5m737rKuDUTfx\naryf/tZ5a45WOiGLvHRTyGiRjoqcPQgIyBqFyKqjmI/q/ZhARzaHkFAJXKRJ\nXAJ+8SWV8HVHdfptxbmegONc9QcNJR3tnqHmiSeE7KSC43gZvsyiy2Q83l0F\nH7WBUXKJKCvv2/C9ngErYovxOO69t2dg11TvYBak7NtJAVwgUGRYMLKv17F4\niMOX6DM01gsUzhMRveksiywrV0EW51vzj0W0Jipn1rWtc5PubhBjLBnXbBNr\nR5EY+MitTJkXtVK6DSHOe+KLEpKba55xl0rE67VtlLAl5a2jNoRBphFui2pz\nB6T8fRakebo5BEZyC/v9thSjbt8pkt6TSZsKTfg1lUCu2+mpSfLQu6tk9TE2\nAsNQcGANMfyRwP4UIuaRrt/zRoK2Lp6MiC/DveDrHKvn1aumsjDWDEDoCTBm\nyoLy8KuSec9b2RTACxUPC3NfQa2MWTiP6/eSZcmetCUcQ5tcd0K23GfzhxFt\nuSdlglsQ9Yoz64yYTm8Xq4sOmv6OadpOl8HmhKU/TjFRs+yJ3SniArobR5QB\nsxv2oDnz0HADWu1aMb3UA7yxT+q3DvL5G/93+NZ784ilnypLow2qryI4UaLI\nuiIt\r\n=cRs/\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCYBi0daUwAuGDwvAX6EqC59OgN1/I3YXsIZ5Hn0NrBmgIhAIPpFfeWAY7T7/RYsDkHmjOkJ0g+6gWRAQYWnyQwy2gz"}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.1-canary.96.c2d5e659995d90bbec3ad6edd1a43757f0b52931.0_1615828015230_0.7024025573891666"},"_hasShrinkwrap":false},"2.11.1":{"name":"@sberdevices/assistant-client","version":"2.11.1","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"a668abb84b274e8091a7128321255ee1369ad06a","bugs":{"url":"https://github.com/sberdevices/assistant-client/issues"},"homepage":"https://github.com/sberdevices/assistant-client#readme","_id":"@sberdevices/assistant-client@2.11.1","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-orXNTK8OhcE0M0oXDXpQTcQS2k+Mdcd99g1xdnSVAYlrFJ0WzIur52xk4Ab9YIqfSh3pDp7m6WYRnsR/8kb/Cw==","shasum":"23bf0560a5ec71a034aa9f7f0de34ab49c71082d","tarball":"https://registry.npmjs.org/@sberdevices/assistant-client/-/assistant-client-2.11.1.tgz","fileCount":50,"unpackedSize":911864,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgT5erCRA9TVsSAnZWagAA8wQQAICrVytq3cTi6/7TrBNV\nTBGHcsi2WO618rCp+DRspl5e/BO299YqeNQqsH3LuXIBYYSOmoOEReUIkf1k\nwUxut/1afITgahtV4/wdz+AfMaP1nflf1AH6gd31TMfg9F8npZmhSKuPcEbe\nVudZaRwudmsM+j2ipXFlueKb0l+yhsD0Tdd2W1R4utGX9WZTmsYEAZU9SDWb\nxOwv2EICdAOztmwajep4xdw4JcWZ+ykLQCFr9YP/MF0hQgOkwub5txZKjZTZ\nDzPSlW8iteTh7t1NaP6BLFIPO9eiuXa6WybfF+RXsa4+9ISYEZ+haCq/NOV2\nJk26kgfhGIx8cYsQGgwQI2bwjk1+WxzcLIaDrNBbDZUkV3ZCzw+ZXbWFkkAR\nVPSJ1DkfvHw+lhGMUP4ocSy/RK35wfLLheaq0WkOZ4fawTz69Y3fqHP5WUfC\n/sNmalsDOBewapvOD4Jmn7orC2Z8b3cPmYe7MpDmYkFANRlx2vFHdxtwTqHs\n7K92AaBtkTUu+OMa9Pf1At+5ptZArwIjzUYosy3Ltfe5BVxJZ5YLtkxWkzBp\nsnQmXZVQAbSY3/4EZ5H1yuqz9hUe0RbORlFd0LtLxCwcL7LuD2Y7hdqXwImM\nHg03PjZzQxKhRiiy5D1G2JhytAn52Es3jLvT2G4g9qHLD9l7sNEBFU0rt+Tr\nzg+3\r\n=5/5k\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCTenX6qtBLAiPSCo19uvx+POCaYUAh//UqRAMoVw2woAIgQngJfyEjQwFXwTTGK3mvK7rU7A7RZu6nDBoiZdyq8b8="}]},"_npmUser":{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"},"directories":{},"maintainers":[{"name":"awinogradov","email":"winogradovaa@gmail.com"},{"name":"turanchoks","email":"ipuncho@gmail.com"},{"name":"andrey.orlow","email":"andrey.orlow@gmail.com"},{"name":"sberdevices-frontend","email":"sberdevices.frontend@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assistant-client_2.11.1_1615828906380_0.7760129600094372"},"_hasShrinkwrap":false},"2.11.2-canary.97.987759fc44c8f795e4220393b16666ce743e6af6.0":{"name":"@sberdevices/assistant-client","version":"2.11.2-canary.97.987759fc44c8f795e4220393b16666ce743e6af6.0","description":"Модуль взаимодействия с виртуальным ассистентом","main":"dist/index.js","unpkg":"umd/assistant.min.js","scripts":{"build":"rm -rf dist umd && rollup -c","prepublishOnly":"npm run build","release":"auto shipit","proto":"pbjs -t static-module src/proto/index.proto > src/proto/index.js && pbts src/proto/index.js -o src/proto/index.d.ts","asr":"pbjs -t static-module src/asr/index.proto > src/asr/index.js && pbts src/asr/index.js -o src/asr/index.d.ts","mtt":"pbjs -t static-module src/mtt/index.proto > src/mtt/index.js && pbts src/mtt/index.js -o src/mtt/index.d.ts","cy:open":"cypress open","cy:run":"cypress run","test:cy":"cypress run -b chromium --headless","lint":"eslint --ext .js,.ts,.tsx src/.","test":"echo \"Error: no test specified\""},"repository":{"type":"git","url":"git+ssh://git@github.com/sberdevices/assistant-client.git"},"keywords":["sber","assistant","smartapp"],"author":{"name":"SberDevices Frontend Team","email":"sberdevices.frontend@gmail.com"},"license":"Sber Public License at-nc-sa v.2","dependencies":{"axios":"0.21.1","protobufjs":"6.10.2","uuid":"8.0.0"},"browserslist":["last 1 Chrome versions"],"devDependencies":{"@auto-it/conventional-commits":"10.2.0","@auto-it/npm":"10.2.0","@auto-it/slack":"^10.3.0","@commitlint/cli":"11.0.0","@commitlint/config-conventional":"11.0.0","@cypress/webpack-preprocessor":"5.4.5","@rollup/plugin-commonjs":"^16.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^10.0.0","@rollup/plugin-typescript":"^6.1.0","@types/jest":"26.0.14","@types/mocha":"8.0.3","@types/react":"16.9.35","@types/react-dom":"16.9.8","@types/uuid":"7.0.3","auto":"10.2.0","cypress":"4.11.0","cypress-react-unit-test":"4.14.2","eslint":"6.8.0","eslint-config-airbnb":"18.1.0","eslint-config-prettier":"6.11.0","eslint-plugin-cypress":"2.11.1","eslint-plugin-flowtype":"4.7.0","eslint-plugin-import":"2.20.2","eslint-plugin-jest":"23.8.2","eslint-plugin-jsx-a11y":"6.2.3","eslint-plugin-prettier":"3.1.3","eslint-plugin-react":"7.19.0","eslint-plugin-react-hooks":"3.0.0","eslint-plugin-testing-library":"^3.10.1","file-loader":"6.1.0","husky":"4.3.0","lint-staged":"^10.5.4","mock-socket":"9.0.3","prettier":"2.1.2","pretty-quick":"3.1.0","react":"^17.0.1","react-dom":"^17.0.1","react-scripts":"3.4.3","rollup":"^2.33.2","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^7.0.2","ts-loader":"8.0.4","tslib":"^2.0.3","typescript":"3.9.2","webpack":"4.44.2"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"auto":{"baseBranch":"main","plugins":[["npm",{"setRcToken":false}],"conventional-commits","slack"]},"gitHead":"987759fc44c8f795e4220393b16666ce743e6af6","readme":"[](https://www.npmjs.com/package/@sberdevices/assistant-client)\n\n\n\n\nAssistant Client - это инструмент для локального тестирования и отладки [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp) c виртуальным ассистентом. Он реализован в виде JavaScript протокола, который эмулирует среду Android и вызывает нативные методы. Такой подход не требует от разработчика наличия физических устройств и позволяет запустить виртуального ассистента через браузер.\n\nПример использования - [небольшое Todo приложение](https://github.com/sberdevices/assistant-client/tree/main/examples/todo-canvas-app), демонстрирует пример взаимодействия с Assistant Client.\n\n## Оглавление\n * [Конфигурация](#Конфигурация)\n * [Аутентификация](#Аутентификация)\n * [Установка](#Установка)\n * [Использование](#пример-использования)\n * [API](#API)\n * [createAssistant](#createAssistant)\n * [createSmartappDebugger](#createSmartappDebugger)\n * [AssistantClient](#assistantclient)\n * [Форматы объектов](#форматы-объектов)\n * [AssistantAppState](#AssistantAppState)\n * [AssistantServerAction](#AssistantServerAction)\n * [AssistantCharacterCommand](#AssistantCharacterCommand)\n * [AssistantNavigationCommand](#AssistantNavigationCommand)\n * [AssistantInsetsCommand](#AssistantInsetsCommand)\n * [AssistantSmartAppError](#AssistantSmartAppError)\n * [AssistantSmartAppCommand](#AssistantSmartAppCommand)\n * [Пульт](#пульт)\n * [Навигация по страницам приложения](#навигация-по-страницам-приложения)\n * [Утилиты для тестирования](#утилиты-для-тестирования)\n * [Требования](#требования-к-устройствам)\n * [FAQ](#faq)\n\n____\n\n## Конфигурация\n\n### Аутентификация\n\nДля работы с Assistant Client необходимо:\n\n1. Завести аккаунт в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/).\n2. Создать приложение с типом [Сanvas App](https://smartapp-code.sberdevices.ru/documentation/#/docs/ru/methodology/research/canvasapp).\n3. Получить токен в Кабинете разработчика и передать его в запросе.\n\nДля получения токена необходимо авторизоваться в [SmartApp Studio](https://smartapp-studio.sberdevices.ru/login) и в рамках Кабинета разработчика перейти в *Настройки профиля* > пункт *Auth Token* > опция *Скопировать ключ*. Полученный токен необходимо передавать в методе `createSmartappDebugger` в параметре `token`.\n\n\n### Установка\n\nДля установки Assistant Client выполните следующую команду:\n\n```sh\n$ npm i @sberdevices/assistant-client\n```\n\n#### Альтернативное подключение\n\nAssitant-client доступен для подключения через `\n\n\n```\n\n\n### Пример использования\n\n```typescript\n// Функция createSmartappDebugger используется в development среде. В production среде необходимо использовать createAssistant.\nimport { createAssistant, createSmartappDebugger } from '@sberdevices/assistant-client';\n\nconst initialize = (getState, getRecoveryState) => {\n if (process.env.NODE_ENV === 'development') {\n return createSmartappDebugger({\n // Токен из Кабинета разработчика\n token: 'token',\n // Пример фразы для запуска приложения\n initPhrase: 'Хочу попкорн',\n // Функция, которая возвращает текущее состояние приложения\n getState,\n // Функция, возвращающая состояние приложения, с которым приложение будет восстановлено при следующем запуске\n getRecoveryState,\n });\n }\n\n\t // Только для среды production\n return createAssistant({ getState, getRecoveryState });\n}\n\n...\n\nconst assistant = initialize(() => state, () => recoveryState);\nassistant.on('data', (command) => {\n // Подписка на команды ассистента, в т.ч. команда инициализации смартапа.\n // Ниже представлен пример обработки голосовых команд \"ниже\"/\"выше\"\n if (command.navigation) {\n switch(command.navigation.command) {\n case 'UP':\n window.scrollTo(0, 0);\n break;\n case 'DOWN':\n window.scrollTo(0, 1000);\n break;\n }\n }\n});\n\nconst handleOnClick = () => {\n // Отправка сообщения ассистенту с фронтенд.\n // Структура может меняться на усмотрение разработчика, в зависимости от бэкенд\n assistant.sendData({ action: { type: 'some_action_name', payload: { param: 'some' } } });\n};\n\nconst handleOnRefreshClick = () => {\n // Отправка сообщения бэкенду, с возможностью подписки на ответ.\n // В обработчик assistant.on('data'), сообщение передано не будет\n const unsubscribe = assistant.sendAction(\n { type: 'some_action_name', payload: { param: 'some' } },\n (data: { type: string; payload: Record }) => {\n // здесь обработка данных, переданных от бэкенд\n unsubscribe();\n },\n (error: { code: number; description: string }) => {\n // обработка ошибки, переданной от бэкенд\n });\n}\n```\n\n____\n\n\n## API\n\n### `createAssistant`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) для запуска виртуального ассистента. Используется на устройствах в production среде.\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :------: | :------------------------------------------------------------------------- |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n\n\n\n### `createSmartappDebugger`\n\nСоздает экземпляр [`AssistantClient`](#assistantclient) и добавляет на экран браузера панель с голосовым ассистентом (подобно устройствам). Панель ассистента находится в нижней части отрисованного экрана и позволяет отправлять виртуальному ассистенту следующие типы сообщений:\n* текстовые сообщения через текстовое поле ввода;\n* голосовые сообщения через кнопку \"Салют\".\n\n`createSmartappDebugger` используется для локальной отладки и разработки в development среде (Dev).\n\n| Параметр | Обязательный | Описание |\n| :--------------- | :----------: | :------------------------------------------------------------------------- |\n| token | Да | Токен из Кабинета Разработчика |\n| initPhrase | Да | Фраза, которая запускает приложение |\n| getState | Да | Функция, которая возвращает актуальное состояние смартапа |\n| getRecoveryState | Нет | Функция, которая сохраняет состояние смартапа на момент последнего закрытия |\n| settings | Нет | Объект [настроек ассистента](#AssistantSettings) |\n\n#### Свойства [Settings](#AssistantSettings)\n\n| Свойство | Значения | По умолчанию | Описание |\n| :------- | :----------: | :----------: | :---------------------------- |\n| dubbing | true / false | true | Озвучивание ответа ассистента |\n\n\n### AssistantClient\n\n#### close(): void\n\nВызывается со стороны смартапа для завершения работы.\n\n#### getInitialData(): [AssistantCommands](#AssistantCommands)[]\n\nВозвращает данные, полученные при инициализации смартапа.\n\n#### getRecoveryState(): any\n\nВозвращает состояние, сохраненное при закрытии приложения. Устройство запоминает последнее состояние, которое возвращает функция getRecoveryState при инициализации Assistant Client.\n\n#### on('start', cb: () => void): void\n\nОсуществляет подписку на событие готовности ассистента к работе.\n\n#### on('data', cb: (data: [AssistantCharacterCommand](#AssistantCharacterCommand) | [AssistantNavigationCommand](#AssistantNavigationCommand) | [AssistantInsetsCommand](#AssistantInsetsCommand) | [AssistantSmartAppError](#AssistantSmartAppError) | [AssistantSmartAppCommand](#AssistantSmartAppCommand)) => {}): void\n\nОсуществляет подписку на событие получения данных с бэкенд.\n\n#### sendAction({ type: string; payload: Record }, params?: { name?: string; requestId?: string }) => void\n\nОтправляет команду бэкенду, позволяет передать обработчики ответа бэкенда и ошибки, полученной от бэкенд. Возвращает функцию для отписки.\n`sendAction` - дженерик, позволяет типизировать сообщения data и error. Вызов `clear()` выполняет отписку от сообщений бэкенда.\nОбработчик assistant.on('data') не получит эти сообщения бэкенда.\n\n\nПример:\n```ts\nimport { AssistantSmartAppCommand } from '@sberdevices/assistant-client';\n\ninterface SomeBackendMessage extends AssistantSmartAppCommand['smart_app_data'] {\n type: 'target_action',\n payload: {\n data: ['some_data'],\n },\n}\n\nconst unsubscribe = assistant.sendAction