Weloopai SDK

Abstract

Weloopai SDK is a set of tools that allows you to integrate the Weloop widget into your app.

Installation

npm install @weloopai/sdk

Usage

import weloopai from "@weloopai/sdk"

// Initialize the SDK
weloopai.init({
  key: "<PROJECT_ID>", // Get your project ID in dashboard > configuration > installation
  autoDisplay: true, // Displays the widget once loaded. default is true, not required
  manuel : false, // this hides the widget to integrate your own button
  user: { 
    groupId: "<GROUP_ID>", 
    language : "<LANGUAGE_CODE>" // Available languages: fr, en, es, it, de, pt.
  }, //not required
  customPosition: {
    // `customPosition` defines the position of the widget on the screen.
    // The default position can be defined from the back-office,
    // but you can override these properties as needed.
    // right: "calc(50vw - 24px)", // Position the widget from the right side with a custom calculation.
    // left: "calc(50vw - 24px)",  // Position the widget from the left side with a custom calculation.
    // bottom: "calc(50vh - 24px)", // Position the widget from the bottom side with a custom calculation.
  },
 
})

Methods

Open the page

The method allows you to open the widget page.

weloopai.openPage()
//default "home"
//params : "home", "feedback", "feedback/add", "faq", "releasenote"

Hide the widget

weloopai.hide()

Show the widget

weloopai.show()

Destroy the widget (iframe)

weloopai.destroy()

Set the Current User

weloopai.setUser({ 
  groupId,  
  // Filters NPS forms based on the user's group ID (if the user is not authenticated).
  language, 
  // Sets the widget language. 
  // If the user connects for the first time, this language will be used as default.
   // Available languages: fr, en, es, it, de, pt.
});

🔒 Logout the User

Logs out the user by opening a popup that calls the remote server to enforce the logout.
The popup automatically closes once the logout is completed.

Usage

await weloopai.setUserLogout();

Or using .then() for Promise handling

weloopai.setUserLogout()
  .then(() => {
    console.log("User successfully logged out");
  })
  .catch((error) => {
    console.error("Logout failed:", error);
  });

Set position of the widget

Defines the position of the widget on the screen. The default position can be defined from the back-office, but you can override these properties as needed.

weloopai.setCustomPosition({ bottom, left, right })