feat: Surveys 2.0

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## Unreleased
+## 19.2.0
+Surveys 2.0: `Gleap.showSurvey(surveyId, options)` takes `{ format: 'card' | 'full' | 'page', fields, personalToken, container, resume }`; the old format strings (`'survey'`, `'survey_full'`, `'survey_web'`) keep working. A survey shown before the SDK is ready now opens once it is.
+New survey containers: the card is a 348px corner popover with an enter animation and becomes a bottom sheet (handle, scrim, home-indicator inset) on phones; full screen covers the whole viewport and the survey draws its own background and close button (no more centred 640px card over a blurred backdrop); `page` renders inline in `container` (or `document.body`) and grows with the survey. Card and page surveys only appear once their height is known. Reduced motion is respected. Legacy surveys (not yet migrated) keep the previous card and full-screen look.
+New events `survey-shown`, `survey-answered`, `survey-completed` and `survey-closed` (with `surveyId`, `version`, `responseId`, …); `outbound-sent` keeps firing as before.
+New standalone `survey-embed.js` (~3 KB): `<div data-gleap-survey="ID" data-api-key="KEY" data-mode="inline|popup|tab">` loads the SDK on demand and shows the survey inline, as a popup or behind a side tab.
 Fixed: inline banners did not show on pages whose `body` clips its overflow, the usual app-shell layout (`html, body { height: 100%; overflow: hidden }`). The banner sits in the body's top margin, which the body cut off, so only an empty strip appeared above the page. On such pages the banner now goes into the body's top padding (added to the page's own padding), which the body does not clip; with `box-sizing: border-box` the app also keeps fitting the viewport instead of losing the banner's height at the bottom. Pages that scroll normally and floating banners are unchanged.
 
 ## 19.1.1

index.d.ts

@@ -276,7 +276,78 @@ export namespace Gleap {
     feedbackFlow: string,
     showBackButton?: boolean
   ): void;
-  function showSurvey(surveyId: string, format?: string): void;
+  type SurveyFormat = "card" | "full" | "page";
+  interface ShowSurveyOptions {
+    /** card = corner popover (bottom sheet on phones), full = full screen, page = inline in `container`. Default: card. */
+    format?: SurveyFormat;
+    /** Values for the survey's hidden fields. */
+    fields?: Record<string, string>;
+    /** Signed personal-link token: attaches the response to that contact. */
+    personalToken?: string;
+    /** Page format: answer with the keyboard while focus is on the host page. */
+    keyboard?: boolean;
+    /** Element (or CSS selector) the page format renders into. Default: document.body. */
+    container?: HTMLElement | string;
+    /** Continue a started response where it was left. */
+    resume?: boolean;
+  }
+  /**
+   * Shows a survey. The legacy format strings ("survey", "survey_full", "survey_web") keep working.
+   */
+  function showSurvey(
+    surveyId: string,
+    formatOrOptions?: "survey" | "survey_full" | "survey_web" | string | ShowSurveyOptions
+  ): void;
+  /** Surveys 2.0 events (reported by the survey renderer; not fired for legacy surveys). */
+  interface SurveyShownEvent {
+    surveyId: string;
+    version: number;
+    format: SurveyFormat;
+    responseId: string;
+    /** true when a started response was continued (resume). */
+    resumed: boolean;
+  }
+  interface SurveyStepViewedEvent {
+    surveyId: string;
+    version: number;
+    responseId: string;
+    /** Zero-based position of the question in the survey. */
+    stepIndex: number;
+    /** Question (block) key. */
+    key: string;
+    [key: string]: any;
+  }
+  interface SurveyAnsweredEvent {
+    surveyId: string;
+    version: number;
+    responseId: string;
+    [key: string]: any;
+  }
+  interface SurveyCompletedEvent {
+    surveyId: string;
+    version: number;
+    responseId: string;
+    endingId: string;
+    /** Answers keyed by question key. */
+    answers: Record<string, any>;
+  }
+  interface SurveyClosedEvent {
+    surveyId: string;
+    version: number;
+    responseId?: string;
+    /** Response status when closed (e.g. "in_progress", "completed"); none when nothing was answered. */
+    status?: string;
+  }
+  /** The survey is visible. */
+  function on(event: "survey-shown", callback: (data: SurveyShownEvent) => void): void;
+  /** A question became visible. */
+  function on(event: "survey-step-viewed", callback: (data: SurveyStepViewedEvent) => void): void;
+  /** An answer was saved. */
+  function on(event: "survey-answered", callback: (data: SurveyAnsweredEvent) => void): void;
+  /** The last question was answered and an ending is shown. `outbound-sent` keeps firing as before. */
+  function on(event: "survey-completed", callback: (data: SurveyCompletedEvent) => void): void;
+  /** The survey was closed (by the user or after its ending). */
+  function on(event: "survey-closed", callback: (data: SurveyClosedEvent) => void): void;
   function on(
     event:
       | "initialized"

package.json

@@ -1,7 +1,7 @@
 {
   "description": "JavaScript and TypeScript SDK for Gleap, an Intercom alternative with AI customer support, live chat, in-app bug reporting and customer feedback.",
   "name": "gleap",
-  "version": "19.1.1",
+  "version": "19.2.0",
   "main": "build/cjs/index.js",
   "module": "build/esm/index.mjs",
   "exports": {