{"_id":"@ac-reusable-dialogs/feedback-elicitation","_rev":"7-38eb634d4cd13137ee3b5157205190e6","name":"@ac-reusable-dialogs/feedback-elicitation","dist-tags":{"latest":"0.0.4"},"versions":{"0.0.3":{"name":"@ac-reusable-dialogs/feedback-elicitation","version":"0.0.3","publisher":"Amazon","description":"ACDL reusable dialog for eliciting feedback from users","license":"AmazonSoftwareLicense","scripts":{"clean":"rm -rf build && rm -rf *.tgz","build":"acc","release":"npm run clean && npm run build && npm pack"},"dependencies":{},"devDependencies":{"@alexa/acdl":"^0.1.0"},"ask":{"srcDir":"src"},"_resolved":"","_integrity":"","_from":"file:ac-reusable-dialogs-feedback-elicitation-0.0.3.tgz","_id":"@ac-reusable-dialogs/feedback-elicitation@0.0.3","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-DNSBTAviSkLk5v2bw11Dgl7FvZnQR50V3sptCSd3icgWecmQ1XX3HiOk4pdObDaQYm9NJPUXcJbbhxiAhe8DRQ==","shasum":"e347f1a6278ab987149fb1682642f471ac0b343f","tarball":"https://registry.npmjs.org/@ac-reusable-dialogs/feedback-elicitation/-/feedback-elicitation-0.0.3.tgz","fileCount":8,"unpackedSize":46615,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhsW0uCRA9TVsSAnZWagAA4dMP/j67jW2tZmzeOOF41XMZ\nVVhG+F/uZH7kiUP8nag+qsenKTcXJGd/8vfeg+Qt33bHhpoTcJCVhU8zp0tK\nWLt5noF6vQzb71bwM514Mjylnx4TaP/ocCWx3azAAE/cHlzSdKmHrijS4qLh\n/U6rUWjv79gRt+0O1X9gAMzQIXPUgGFxLBTcs1oJVBq1se/PD22fbUH0fnXd\nyaG+BURF4Pi4bTUBpralzjsdbilu3NeL7mSlzoAjXrzcx2cJEMNL6W6jDLTv\nNwnI4saos1MHauy0qa9sBbT1LmIwtcaGx4y/KvGYOvutOX5vSwI998y9wq72\n6Epsmh8icaFnScYWoLBod2sMq5SZDB/aRJdCPw45kZnrmyXLEwbZiWoI9I2g\nnvy+brQCauEpfkO2OG4N7QVWXucVDPtvlM6jPWIKZSl9CvK4L8cmEKJDCs3X\nN83bZcGHSjPq8HmYr4hWZJ6BUC3MHBeJV9imWgN1kKsGIbw/DsTHhxNOExKm\nevLy/zGhkg6MKt7T3jU4EFr5RZdHgNnU7N1YjtfYRnJ8UjNXSzUbkcxtSj5U\neBwgQ6/wk8fw+nYHFz8PLt9PpvM7664b09D7zBN0L0aEs/awg8uksknyPAH3\nNUIRzkx2wAGYdpLvhSpwrTqd2zUE78T6JrQcJ5cFsclyEr0NKXYBUriZYPbQ\nAQft\r\n=sx7Y\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCYyktU6yhvahDiYm985Tp0CIr42lRVVxOqQo+VStsuNQIgRffyixjut7pZB9DaRVxP0zQpNMfHRl74UB6BfWT20XI="}]},"_npmUser":{"name":"aakabala","email":"aakabala@amazon.com"},"directories":{},"maintainers":[{"name":"aakabala","email":"aakabala@amazon.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/feedback-elicitation_0.0.3_1639017774616_0.7816980172153696"},"_hasShrinkwrap":false},"0.0.4":{"name":"@ac-reusable-dialogs/feedback-elicitation","version":"0.0.4","publisher":"Amazon","description":"ACDL reusable dialog for eliciting feedback from users","license":"AmazonSoftwareLicense","scripts":{"clean":"rm -rf build && rm -rf *.tgz","build":"acc","release":"npm run clean && npm run build && npm pack"},"dependencies":{},"devDependencies":{"@alexa/acdl":"^0.1.0"},"ask":{"srcDir":"src"},"_resolved":"","_integrity":"","_from":"file:ac-reusable-dialogs-feedback-elicitation-0.0.4.tgz","_id":"@ac-reusable-dialogs/feedback-elicitation@0.0.4","_nodeVersion":"12.20.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-iiHe43hcr2L9a+UHZswrmVPxDmfaIIa44SABusUVnVn+qTxsl9yFvuV3HSiCbyOib5Kag+8IohC1oeXom4BB5Q==","shasum":"8f839fedd6ba50cd522610ee08b2e84c26c38ff2","tarball":"https://registry.npmjs.org/@ac-reusable-dialogs/feedback-elicitation/-/feedback-elicitation-0.0.4.tgz","fileCount":8,"unpackedSize":46621,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiHpbrACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo8Wg//WRuglErvJEfBF8wAo0JuOJKznaJcqE47cdEdzBYsMg1Ka5ES\r\nCOJtpcoW5bsPSe0DgD8tBsSMtVYWXYTM8+JslSlvBjHLFVo6yH1C1wCY+xfs\r\njhrTIU5vkrqBY2TfSj62Eb9mftQb5wZbu21BrOtauZ1R+Ez3OcwawKEVSR6t\r\nRDF7ISBmVo0gW5TLW42WSqbmjBEt+VgSam5Fa07AxWmEo6eLvfKdNLh4DBUU\r\nEa5XsYnahyEmNEuvnED+Nswx5imd4j8j7YroCLHjt80VGHyi4DTq8Sm7iATp\r\naJhgqboP2dsI8R4DuuTAGKGJ8BjwmZlQrD9+kV0ByzyUfpYi9Z211WXO2TYS\r\n3iGaI0lkt9f8nej9q/7BJbHDwk399385tZpAl2N0aFKwONPW9FVO1WA3h1Ro\r\nZQ8So7xjx8okW2OIjyELwqPBQzWFRXqMVzkDuSrD4+tWtpuKk+vb99H+aHEe\r\nPe1I94/aoHvamnqg7PmzUNDNzgLLAa0OoEDmdK38YM1I/HZanxD1bLfVMoCq\r\nn5TeQ96pGoVr0111VL8BgLaXy/JUJ1SHZ+Vr59n5YxZBtei7EljyyAR5dXie\r\nZ8IfLuAjxlgCkkY9dU0/xScGLddjk+dwPAAhaEEo8YCsoaTyk2LEOAjX/mUG\r\nOXoaphoXx24Cmwpb3a0UcoYDK0Db2ljIZE8=\r\n=hRKU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIB0lb+CkpZH+Z013GtH7q2VMmgincEvAgVM968dYrqOZAiAHuA0hR4HOx32eDvTSH7/icmmGftQp4BPVyJYDEo7sxg=="}]},"_npmUser":{"name":"aakabala","email":"aakabala@amazon.com"},"directories":{},"maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aakabala","email":"aakabala@amazon.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/feedback-elicitation_0.0.4_1646171883693_0.4830967176977532"},"_hasShrinkwrap":false}},"time":{"created":"2021-12-09T02:16:22.090Z","0.0.1":"2021-12-09T02:16:22.257Z","modified":"2022-04-04T11:04:42.646Z","0.0.2":"2021-12-09T02:25:04.889Z","0.0.3":"2021-12-09T02:42:54.741Z","0.0.4":"2022-03-01T21:58:03.877Z"},"maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aakabala","email":"aakabala@amazon.com"}],"description":"ACDL reusable dialog for eliciting feedback from users","license":"AmazonSoftwareLicense","readme":"## Feedback Elicitation Reusable Dialog\n___\n\nFeedback Elicitation is an ACDL Reusable Dialog that gives skill developers an easy way to collect feedback about their skill from customers. Currently, Feedback Elicitation requests and collects a numeric rating from the user.\n\n\n## Installation\n___\n\n1. Install the latest version of [acc (@alexa/acdl)](https://www.npmjs.com/package/@alexa/acdl) globally\n ```\n npm i -g @alexa/acdl\n ```\n2. Install [@ac-reusable-dialogs/feedback-elicitation](https://www.npmjs.com/package/@ac-reusable-dialogs/feedback-elicitation)\n```\nnpm i @ac-reusable-dialogs/feedback-elicitation\n```\n\n## Overview\n___\n\n### Arguments:\n\n| Name |Type | Description |\n|---|---|---|\n| feedback_prompt | APLA | The APLA response prompt to be used for requesting feedback |\n| payload | Thing | Response payload of the previous action called |\n| notifyAction | Action | Previous action called before calling the FeedbackElicitation dialog |\n\t\t\t\t\t\t\n### Return:\n| Type | Description |\n|---|---|\n| Nothing | `nothing` literal |\n\n** Feedback Elicitation must be called after an action call. It will act as the response after the action then offer up the feedback elicitation action.\n\n\n## Usage\n___\n\n### Basic example:\n\n```\n...\nimport com.ac.reusable.dialogs.feedback.*\n\nsample_apla = apla(\"../resources/prompts/sample_apla/document.json\")\n\ntype SamplePayload {\n    Number num\n}\n\naction Number sampleAction()\n\n...\n\nsample {\n    ...\n    x = sampleAction()\n    GetFeedback(feedback_prompt=sample_apla, payload = SamplePayload {num = x}, notifyAction = sampleAction)\n    ...\n}\n```\n\n\n### Example skill: \nThis is NumberBot, a skill that generates a random number, then collects feedback on the experience\n\n```\nnamespace com.numberbot\n\nimport com.amazon.alexa.ask.conversations.*\nimport com.amazon.ask.types.builtins.AMAZON.*\nimport com.amazon.alexa.schema.Nothing\nimport com.amazon.alexa.schema.Thing\nimport com.amazon.alexa.schema.Number\nimport com.ac.reusable.dialogs.feedback.*\n\nnumericfeedback_apla = apla(\"../response/prompts/numericfeedback_apla/document.json\")\n\nmySkill = skill(\n    locales = [Locale.en_US],\n    dialogs = [MainDialog],\n    skillLevelResponses = SkillLevelResponses\n        {\n            welcome = prompts.AlexaConversationsWelcome,\n            out_of_domain = prompts.AlexaConversationsOutOfDomain,\n            bye = prompts.AlexaConversationsBye,\n            reqmore = prompts.AlexaConversationsRequestMore,\n            provide_help = prompts.AlexaConversationsProvideHelp\n        },\n    invocationNames = [ InvocationName \n        {\n            locale = Locale.en_US,\n            invocationName = \"acdl number feedback bot\"  \n        }\n    ]\n)\n\ntype NumPayload {\n    Number num\n}\n\ngetStart = utterances([\"give me a number please\"])\n\naction Number getNumber()\n\n//main\ndialog Nothing MainDialog {\n    sample {\n        expect(Invoke, getStart)\n        number = getNumber()\n        //Feedback Elicitation usage\n        GetFeedback(numericfeedback_apla, payload = NumPayload {num = number}, notifyAction = getNumber)  \n    }\n}\n```\n\n\n### Invalid Examples:\n1. There is no action call prior to GetFeedback\n\n```\nsample {\n    expect(Invoke, getStart)\n    //Feedback Elicitation usage\n    GetFeedback(numericfeedback_apla, payload = NumPayload {num = num}, notifyAction = getNumber)  \n}\n```\n\n2. GetFeedback already acts as a response, it cannot be directly followed by an additional response\n\n```\nsample {\n    expect(Invoke, getStart)\n    //Feedback Elicitation usage\n    GetFeedback(numericfeedback_apla, payload = NumPayload {num = num}, notifyAction = getNumber)  \n    response(sample_apla, Notify {actionName = getNumber}, payload = NumPayload {num = num})\n}\n```\n\n\n## Alexa/User Turns example\n___\n\n...\n\n<span style=\"color:cyan\">Alexa:</span> Please give this interaction a rating between 1-5, where 5 is the highest rating\n\n<span style=\"color:lime\">User:</span> Two\n\n<span style=\"color:cyan\">Alexa:</span> Thank you for the feedback!\n\n...\n\n___\n\n## License\n___\nThis library is licensed under the Amazon Software License.\n\n","readmeFilename":"README.md"}