survicate_widget.d.ts

type CallbackType = (surveyId: string, answer?: any) => void;

type QuestionAnsweredCallback = (surveyId: string, questionId: number, answer: any) => void;

type AttributeValue = string | number | boolean | Date;

interface VisitorAttributes {
  [key: string]: AttributeValue;
}

export type CallbackTypes = CallbackType | QuestionAnsweredCallback;

export enum SurveyType {
  WidgetSurvey = 'WidgetSurvey',
  PageSurvey = 'PageSurvey',
  MobileSurvey = 'MobileSurvey',
  FeedbackButton = 'FeedbackButton',
  IntercomSurvey = 'IntercomSurvey'
}

export interface ShowSurveyOptions {
  forceDisplay?: true;
  displayMethod?: AppearMethodApi;
  displayOptions?: {
    delay?: number;
    scrolledPercentage?: number;
  };
}

export enum AppearMethodApi {
  immediately = 'immediately',
  delayed = 'delayed',
  exitIntent = 'exitIntent',
  scroll = 'onScroll',
}

export enum ApiEvents {
  questionAnswered = 'question_answered',
  surveyDisplayed = 'survey_displayed',
  surveyCompleted = 'survey_completed',
  surveyClosed = 'survey_closed',
}
export interface ConfigModel {
  disableTargeting?: true;
  nonce?: string;
  traits?: {[key: string]: any};
  workspaceKey: string;
}

export interface SurveyApi {
  addEventListener: (event: ApiEvents, callback: CallbackTypes) => number | void;
  destroyVisitor: (callback?: () => void) => void;
  disableTargeting?: boolean;
  getSurvey: () => Record<string, Record<string, string>>;
  getVisitorId: (surveyType?: SurveyType) => string;
  invokeEvent: (eventName: string, eventProperties?: Record<string, string>) => void;
  removeEventListener: (eventId: number | ApiEvents) => void;
  retarget: () => void;
  setVisitorTraits: (attributes: VisitorAttributes) => void;
  showSurvey: (id: string, options: ShowSurveyOptions) => boolean;
  traits?: VisitorAttributes;
}

declare const Survicate: {
  ApiEvent: typeof ApiEvents;
  AppearMethod: typeof AppearMethodApi;
  addEventListener: (event: ApiEvents, callback: CallbackTypes) => number | void;
  destroyVisitor: (callback?: () => void) => void;
  disableTargeting?: boolean;
  getSurvey: () => Record<string, Record<string, string>>;
  getVisitorId: (surveyType?: SurveyType) => string;
  init: (config: ConfigModel) => Promise<null | void>;
  invokeEvent: (eventName: string, eventProperties?: Record<string, string>) => void;
  removeEventListener: (eventId: number | ApiEvents) => void;
  retarget: () => void;
  setVisitorTraits: (attributes: VisitorAttributes) => void;
  showSurvey: (id: string, options: ShowSurveyOptions) => boolean;
  traits?: VisitorAttributes;
};

export default Survicate;