@survicate/survicate-web-package 21.0.0-npm → 21.0.1-npm

package/README.md

@@ -7,14 +7,24 @@ It's built on top of [Preact](https://github.com/preactjs/preact) using [Typescr
 
 
 # Initialization 
-Find your workspace key under *settings > survey settings > web surveys* in the [Survicate Panel](https://panel.survicate.com/). 
+Find your workspace key in the [Survicate Panel](https://panel.survicate.com/o/0/w/0/settings/access-keys). 
 
 ```
 import Survicate from '@survicate/survicate-web-package/survicate_widget'
 
-Survicate.init({workspaceKey: `${key}`});
+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/).
 
-All available methods can be found in our [documentation](https://developers.survicate.com/javascript/methods/).
+
+## Examples:
+
+Based on the respondent's interaction with our surveys you can trigger actions in your app or website:
+
+```
+Survicate.addEventListener(Survicate.ApiEvent.questionAnswered, () => console.log("question answered"));
+
+```

package/package.json

@@ -1,14 +1,11 @@
 {
-  "version": "21.0.0-npm",
+  "version": "21.0.1-npm",
   "name": "@survicate/survicate-web-package",
   "description": "Survicate Web Package",
   "author": {
     "name": "Survicate",
     "email": "help@survicate.com"
   },
-  "engines": {
-    "node": "18.7.1"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Survicate/survicate-web-package.git"
@@ -19,5 +16,5 @@
     "url": "https://github.com/Survicate/survicate-web-package/issues"
   },
   "main": "survicate_widget.js",
-  "types": "./survicate_widget.d.ts"
+  "types": "survicate_widget.d.ts"
 }

package/survicate_widget.d.ts

@@ -1,30 +1,5 @@
-declare const Survicate: {
-  init: (config: { workspaceKey: string }) => Promise<null | void>;
-  load: () => void;
-  addEventListener: (
-    event: SurvicateApiEvents,
-    callback: SurvicateCallbackTypes
-  ) => void;
-  destroyVisitor: (callback?: () => void) => void;
-  disableTargeting?: boolean;
-  getState: () => SurvicateState;
-  getSurvey: () => { id: string | null; name: string | null };
-  getVisitorId: () => string;
-  removeEventListener: (eventId: number) => void;
-  retarget: () => void;
-  setVisitorTraits: (attributes: SurvicateVisitorAttributes) => void;
-  showSurvey: (id: string, options: ShowSurveyOptions) => void;
-  traits?: SurvicateVisitorAttributes;
-};
-
-export enum SurvicateApiEvents {
-  questionAnswered = 'question_answered',
-  surveyDisplayed = 'survey_displayed',
-  surveyCompleted = 'survey_completed',
-  surveyClosed = 'survey_closed',
-}
-
 type SurvicateCallbackType = (surveyId: string, answer?: unknown) => void;
+
 type SurvicateQuestionAnsweredCallback = (
   surveyId: string,
   questionId: number,
@@ -39,60 +14,46 @@ export interface SurvicateVisitorAttributes {
   [key: string]: string;
 }
 
-type WindowWithSvd = Window & {
-  _svd: unknown;
-};
-
-export interface SurvicateState {
-  backendData: unknown;
-  backendService: unknown | null;
-  isKioskMode: boolean;
-  isPreview: boolean;
-  previewDevice: unknown;
-  sampledSurveys: unknown | null;
-  storageService: unknown | null;
-  surveyApiState: unknown;
-  surveyState: SurvicateSurveyState;
-  tabId: number;
-  update: WindowWithSvd | Record<string, unknown>;
-  visit: unknown;
-  visitor: unknown;
-}
-
-export interface SurvicateSurveyState {
-  survey: unknown | null;
-  theme: unknown | null;
-  pointsDisplayed: unknown[];
-  pointsForward: unknown[];
-  pointsAnswered: {
-    [id: number]: boolean;
-  };
-  responseUuid: string;
-  isMinimized: boolean;
-  isOverlayActive: boolean;
-  isFinished: boolean;
-  isAlreadyAnswered: boolean;
-  isAnsweredByEmail: boolean;
-  triggeredPointPreview: number | null;
-  forceDisplay?: boolean;
-  translations: unknown | null;
-  translationLanguage: string | null;
-}
-
 export interface ShowSurveyOptions {
   forceDisplay?: true;
-  displayMethod?: SurvicateAppearMethod;
+  displayMethod?: AppearMethod;
   displayOptions?: {
     delay?: number;
     scrolledPercentage?: number;
   };
 }
 
-export enum SurvicateAppearMethod {
+export enum AppearMethod {
   immediately = 'immediately',
   delayed = 'delayed',
   exitIntent = 'exitIntent',
   scroll = 'onScroll',
 }
 
+export enum ApiEvent {
+  questionAnswered = 'question_answered',
+  surveyDisplayed = 'survey_displayed',
+  surveyCompleted = 'survey_completed',
+  surveyClosed = 'survey_closed',
+}
+
+declare const Survicate: {
+  init: (config: { workspaceKey: string }) => Promise<null | void>;
+  addEventListener: (
+    event: ApiEvent,
+    callback: SurvicateCallbackTypes
+  ) => number | void;
+  destroyVisitor: (callback?: () => void) => void;
+  disableTargeting?: boolean;
+  getSurvey: () => { id: string | null; name: string | null };
+  getVisitorId: () => string;
+  removeEventListener: (eventId: number | ApiEvent) => void;
+  retarget: () => void;
+  setVisitorTraits: (attributes: SurvicateVisitorAttributes) => void;
+  showSurvey: (id: string, options: ShowSurveyOptions) => boolean;
+  traits?: SurvicateVisitorAttributes;
+  ApiEvent: typeof ApiEvent;
+  AppearMethod: typeof AppearMethod;
+};
+
 export default Survicate;