@survicate/survicate-web-package 22.1.0-npm → 22.4.0-npm

package/README.md

@@ -1,30 +1,47 @@
 # Survicate Web Package
-This package allows you to run a web survey directly in your code. 
+This package allows you to run a web survey directly in your code.
 It's built on top of [Preact](https://github.com/preactjs/preact) using [Typescript](https://github.com/Microsoft/TypeScript) and [CSS Modules](https://github.com/css-modules/css-modules).
 
 # Installation
-`npm install @survicate/survicate-web-package --save` 
+`npm install @survicate/survicate-web-package --save`
 
 
-# Initialization 
-Find your workspace key in the [Survicate Panel](https://panel.survicate.com/o/0/w/0/settings/access-keys). 
+# Initialization
+Find your workspace key in the [Survicate Panel](https://panel.survicate.com/o/0/w/0/settings/access-keys).
 
-```
+```javascript
 import Survicate from '@survicate/survicate-web-package/survicate_widget'
 
 const key = "..." // Your key from the panel
 Survicate.init({workspaceKey: key});
 ```
 
-# Available methods
-All available methods can be found in our [documentation](https://developers.survicate.com/javascript/methods/).
+## Examples:
 
+To call available methods:
 
-## Examples:
+```javascript
+import Survicate from '@survicate/survicate-web-package/survicate_widget'
 
-Based on the respondent's interaction with our surveys you can trigger actions in your app or website:
+// Initialize survicate:
+const key = "..." // Your key from the panel
+Survicate.init({workspaceKey: key});
+
+// Show survey with force option
+Survicate.showSurvey('surveyId', { forceDisplay: true });
+
+// Set user attributes
+Survicate.setVisitorTraits({name: 'userName', lastName: 'userLastName'});
+
+// Add event listener
+Survicate.addEventListener(ApiEvent.questionAnswered , () => console.log('question answered'));
+
+// Remove eventListener
+Survicate.removeEventListener(ApiEvent.questionAnswered);
 
 ```
-Survicate.addEventListener(Survicate.ApiEvent.questionAnswered, () => console.log("question answered"));
+*Please refer to the [documentation](https://developers.survicate.com/javascript/methods/) for the rest of the methods.*
+
+# Changelog
 
-```
+The Survicate JavaScript SDK changelog can be found [here](https://developers.survicate.com/javascript/js-sdk-changelog/)

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "22.1.0-npm",
+  "version": "22.4.0-npm",
   "name": "@survicate/survicate-web-package",
   "description": "Survicate Web Package",
   "author": {

package/survicate_widget.d.ts

@@ -54,6 +54,7 @@ declare const Survicate: {
   traits?: SurvicateVisitorAttributes;
   ApiEvent: typeof ApiEvent;
   AppearMethod: typeof AppearMethod;
+  invokeEvent: (eventName: string, eventProperties?: Record<string, any>) => void;
 };
 
 export default Survicate;