chayns-api 1.0.1 → 1.0.3

package/dist/cjs/calls/index.js

@@ -4,393 +4,247 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.vibrate = exports.user = exports.storageSetItem = exports.storageRemoveItem = exports.storageGetItem = exports.site = exports.setWaitCursor = exports.setTempDesignSettings = exports.setScanQrCode = exports.setRefreshScrollEnabled = exports.setOverlay = exports.setHeight = exports.setFloatingButton = exports.setDisplayTimeout = exports.setAdminMode = exports.sendMessageToUser = exports.sendMessageToPage = exports.sendMessageToGroup = exports.selectPage = exports.scrollToY = exports.removeWindowMetricsListener = exports.removeVisibilityChangeListener = exports.removeScrollListener = exports.removeGeoLocationListener = exports.refreshData = exports.refreshAccessToken = exports.parameters = exports.pages = exports.openVideo = exports.openUrl = exports.openImage = exports.navigateBack = exports.logout = exports.login = exports.language = exports.invokeDialogCall = exports.invokeCall = exports.getWindowMetrics = exports.getUserInfo = exports.getUser = exports.getSite = exports.getScrollPosition = exports.getParameters = exports.getPages = exports.getLanguage = exports.getGeoLocation = exports.getEnvironment = exports.getDevice = exports.getAvailableSharingServices = exports.getAccessToken = exports.environment = exports.device = exports.customCallbackFunction = exports.addWindowMetricsListener = exports.addVisibilityChangeListener = exports.addScrollListener = exports.addGeoLocationListener = void 0;
-
 var _ChaynsProvider = require("../components/ChaynsProvider");
-
-/**
- * This adds a listener to determine your location.
- * @category Event listener
+/**
+ * This adds a listener to determine your location.
+ * @category Event listener
  */
 const addGeoLocationListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addGeoLocationListener(...args);
-/**
- * Adds a listener for scroll event by user.
- * @category Event listener
+/**
+ * Adds a listener for scroll event by user.
+ * @category Event listener
  */
-
-
 exports.addGeoLocationListener = addGeoLocationListener;
-
 const addScrollListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addScrollListener(...args);
-/**
- * This method will be executed when the page gets displayed or hidden.
- * @category Event listener
+/**
+ * This method will be executed when the page gets displayed or hidden.
+ * @category Event listener
  */
-
-
 exports.addScrollListener = addScrollListener;
-
 const addVisibilityChangeListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addVisibilityChangeListener(...args);
-/**
- * This adds a listener to get the actual height of the page.
- * @category Event listener
+/**
+ * This adds a listener to get the actual height of the page.
+ * @category Event listener
  */
-
-
 exports.addVisibilityChangeListener = addVisibilityChangeListener;
-
-const addWindowMetricsListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addWindowMetricsListener(...args);
-/**
-* Allows a custom callback function to be defined
-*/
-
-
+const addWindowMetricsListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addWindowMetricsListener(...args); /**
+                                                                                                                                 * Allows a custom callback function to be defined
+                                                                                                                                 */
 exports.addWindowMetricsListener = addWindowMetricsListener;
-
 const customCallbackFunction = (...args) => _ChaynsProvider.moduleWrapper.current.functions.customCallbackFunction(...args);
-/**
- * Get the accessToken from the user.
+/**
+ * Get the accessToken from the user.
  */
-
-
 exports.customCallbackFunction = customCallbackFunction;
-
 const getAccessToken = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getAccessToken(...args);
-/**
- * This method returns a list of installed share/social media apps.
+/**
+ * This method returns a list of installed share/social media apps.
  */
-
-
 exports.getAccessToken = getAccessToken;
-
 const getAvailableSharingServices = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getAvailableSharingServices(...args);
-/**
- * This method determines your location. If you want to track a route, use addGeoLocationListener.
+/**
+ * This method determines your location. If you want to track a route, use addGeoLocationListener.
  */
-
-
 exports.getAvailableSharingServices = getAvailableSharingServices;
-
 const getGeoLocation = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getGeoLocation(...args);
-/**
- * This method returns user information for a specific user.
- * @category User functions
+/**
+ * This method returns user information for a specific user.
+ * @category User functions
  */
-
-
 exports.getGeoLocation = getGeoLocation;
-
 const getUserInfo = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getUserInfo(...args);
-/**
- * Return the current scroll position of the top frame
+/**
+ * Return the current scroll position of the top frame
  */
-
-
 exports.getUserInfo = getUserInfo;
-
 const getScrollPosition = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getScrollPosition(...args);
-/**
- * Returns the window metrics.
+/**
+ * Returns the window metrics.
  */
-
-
 exports.getScrollPosition = getScrollPosition;
-
 const getWindowMetrics = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getWindowMetrics(...args);
 /** @internal */
-
-
 exports.getWindowMetrics = getWindowMetrics;
-
 const invokeCall = (...args) => _ChaynsProvider.moduleWrapper.current.functions.invokeCall(...args);
 /** @internal */
-
-
 exports.invokeCall = invokeCall;
-
 const invokeDialogCall = (...args) => _ChaynsProvider.moduleWrapper.current.functions.invokeDialogCall(...args);
-/**
- * This method will show a login dialog where the user has the opportunity to log in.
+/**
+ * This method will show a login dialog where the user has the opportunity to log in.
  */
-
-
 exports.invokeDialogCall = invokeDialogCall;
-
 const login = (...args) => _ChaynsProvider.moduleWrapper.current.functions.login(...args);
-/**
- * This method will logout the user
+/**
+ * This method will logout the user
  */
-
-
 exports.login = login;
-
 const logout = (...args) => _ChaynsProvider.moduleWrapper.current.functions.logout(...args);
-/**
- * This function navigates you to the previous site.
+/**
+ * This function navigates you to the previous site.
  */
-
-
 exports.logout = logout;
-
 const navigateBack = (...args) => _ChaynsProvider.moduleWrapper.current.functions.navigateBack(...args);
-/**
- * The images specified in the url array is shown in gallery mode.
+/**
+ * The images specified in the url array is shown in gallery mode.
  */
-
-
 exports.navigateBack = navigateBack;
-
 const openImage = (...args) => _ChaynsProvider.moduleWrapper.current.functions.openImage(...args);
-/**
- * Opens an URL in the chayns environment.
+/**
+ * Opens an URL in the chayns environment.
  */
-
-
 exports.openImage = openImage;
-
 const openUrl = (...args) => _ChaynsProvider.moduleWrapper.current.functions.openUrl(...args);
-/**
- * The video specified in the URL is shown in video mode.
+/**
+ * The video specified in the URL is shown in video mode.
  */
-
-
 exports.openUrl = openUrl;
-
 const openVideo = (...args) => _ChaynsProvider.moduleWrapper.current.functions.openVideo(...args);
-/**
- * Refresh badge count in navigation, user information and pages
+/**
+ * Refresh badge count in navigation, user information and pages
  */
-
-
 exports.openVideo = openVideo;
-
 const refreshData = (...args) => _ChaynsProvider.moduleWrapper.current.functions.refreshData(...args);
-/**
- * Refresh accesstoken, should only be used when user object changes, not when token is invalid
+/**
+ * Refresh accesstoken, should only be used when user object changes, not when token is invalid
  */
-
-
 exports.refreshData = refreshData;
-
 const refreshAccessToken = (...args) => _ChaynsProvider.moduleWrapper.current.functions.refreshAccessToken(...args);
-/**
- * This removes a listener to determine your location.
- * @category Event listener
+/**
+ * This removes a listener to determine your location.
+ * @category Event listener
  */
-
-
 exports.refreshAccessToken = refreshAccessToken;
-
 const removeGeoLocationListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeGeoLocationListener(...args);
-/**
- * Removes scroll listener.
- * @category Event listener
+/**
+ * Removes scroll listener.
+ * @category Event listener
  */
-
-
 exports.removeGeoLocationListener = removeGeoLocationListener;
-
 const removeScrollListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeScrollListener(...args);
-/**
- * Removes visibility change listener.
- * @category Event listener
+/**
+ * Removes visibility change listener.
+ * @category Event listener
  */
-
-
 exports.removeScrollListener = removeScrollListener;
-
 const removeVisibilityChangeListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeVisibilityChangeListener(...args);
-/**
- * Removes window metrics listener.
- * @category Event listener
+/**
+ * Removes window metrics listener.
+ * @category Event listener
  */
-
-
 exports.removeVisibilityChangeListener = removeVisibilityChangeListener;
-
 const removeWindowMetricsListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeWindowMetricsListener(...args);
-/**
- * Select other page on chayns site.
+/**
+ * Select other page on chayns site.
  */
-
-
 exports.removeWindowMetricsListener = removeWindowMetricsListener;
-
 const selectPage = (...args) => _ChaynsProvider.moduleWrapper.current.functions.selectPage(...args);
-/**
- * Scrolls to specific position.
+/**
+ * Scrolls to specific position.
  */
-
-
 exports.selectPage = selectPage;
-
 const scrollToY = (...args) => _ChaynsProvider.moduleWrapper.current.functions.scrollToY(...args);
-/**
- * Sends intercom message to group.
+/**
+ * Sends intercom message to group.
  */
-
-
 exports.scrollToY = scrollToY;
-
 const sendMessageToGroup = (...args) => _ChaynsProvider.moduleWrapper.current.functions.sendMessageToGroup(...args);
-/**
- * Sends intercom message to page.
+/**
+ * Sends intercom message to page.
  */
-
-
 exports.sendMessageToGroup = sendMessageToGroup;
-
 const sendMessageToPage = (...args) => _ChaynsProvider.moduleWrapper.current.functions.sendMessageToPage(...args);
-/**
- * Sends intercom message to an user.
+/**
+ * Sends intercom message to an user.
  */
-
-
 exports.sendMessageToPage = sendMessageToPage;
-
 const sendMessageToUser = (...args) => _ChaynsProvider.moduleWrapper.current.functions.sendMessageToUser(...args);
-/**
- * Switches admin mode, also toggles admin switch in top frame.
+/**
+ * Switches admin mode, also toggles admin switch in top frame.
  */
-
-
 exports.sendMessageToUser = sendMessageToUser;
-
 const setAdminMode = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setAdminMode(...args);
-/**
- * Sets the display timeout, only works in chayns App.
+/**
+ * Sets the display timeout, only works in chayns App.
  */
-
-
 exports.setAdminMode = setAdminMode;
-
 const setDisplayTimeout = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setDisplayTimeout(...args);
-/**
- * Enables or disables a button which floats over the page.
+/**
+ * Enables or disables a button which floats over the page.
  */
-
-
 exports.setDisplayTimeout = setDisplayTimeout;
-
 const setFloatingButton = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setFloatingButton(...args);
-/**
- * Sets the height of the page.
+/**
+ * Sets the height of the page.
  */
-
-
 exports.setFloatingButton = setFloatingButton;
-
 const setHeight = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setHeight(...args);
-/**
- * Enables or disables the ability to refresh a page
+/**
+ * Enables or disables the ability to refresh a page
  */
-
-
 exports.setHeight = setHeight;
-
 const setRefreshScrollEnabled = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setRefreshScrollEnabled(...args);
-/**
- * Scans a qr-code and returns the result
+/**
+ * Scans a qr-code and returns the result
  */
-
-
 exports.setRefreshScrollEnabled = setRefreshScrollEnabled;
-
 const setScanQrCode = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setScanQrCode(...args);
-/**
- * Temporarily change design settings in top frame
+/**
+ * Temporarily change design settings in top frame
  */
-
-
 exports.setScanQrCode = setScanQrCode;
-
 const setTempDesignSettings = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setTempDesignSettings(...args);
-/**
- * Shows or hide a waitcursor
+/**
+ * Shows or hide a waitcursor
  */
-
-
 exports.setTempDesignSettings = setTempDesignSettings;
-
 const setWaitCursor = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setWaitCursor(...args);
-/**
- * Retrieves the value that is assigned to the key from a storage outside the frame
+/**
+ * Retrieves the value that is assigned to the key from a storage outside the frame
  */
-
-
 exports.setWaitCursor = setWaitCursor;
-
 const storageGetItem = (...args) => _ChaynsProvider.moduleWrapper.current.functions.storageGetItem(...args);
-/**
- * Removes the value that is assigned to the key from a storage outside the frame
+/**
+ * Removes the value that is assigned to the key from a storage outside the frame
  */
-
-
 exports.storageGetItem = storageGetItem;
-
 const storageRemoveItem = (...args) => _ChaynsProvider.moduleWrapper.current.functions.storageRemoveItem(...args);
-/**
- * Sets the value that is assigned to the key from a storage outside the frame
+/**
+ * Sets the value that is assigned to the key from a storage outside the frame
  */
-
-
 exports.storageRemoveItem = storageRemoveItem;
-
 const storageSetItem = (...args) => _ChaynsProvider.moduleWrapper.current.functions.storageSetItem(...args);
-/**
- * This method lets a smartphone vibrate for the given time.
+/**
+ * This method lets a smartphone vibrate for the given time.
  */
-
-
 exports.storageSetItem = storageSetItem;
-
 const vibrate = (...args) => _ChaynsProvider.moduleWrapper.current.functions.vibrate(...args);
-/**
- * Displays an overlay
+/**
+ * Displays an overlay
  */
-
-
 exports.vibrate = vibrate;
-
 const setOverlay = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setOverlay(...args);
-/**
- * Returns user information, only when user is logged in
- * @category User functions
+/**
+ * Returns user information, only when user is logged in
+ * @category User functions
  */
-
-
 exports.setOverlay = setOverlay;
-
 const getUser = () => _ChaynsProvider.moduleWrapper.current.values.user;
-
 exports.getUser = getUser;
-
 const getSite = () => _ChaynsProvider.moduleWrapper.current.values.site;
-
 exports.getSite = getSite;
-
 const getDevice = () => _ChaynsProvider.moduleWrapper.current.values.device;
-
 exports.getDevice = getDevice;
-
 const getLanguage = () => _ChaynsProvider.moduleWrapper.current.values.language;
-
 exports.getLanguage = getLanguage;
-
 const getParameters = () => _ChaynsProvider.moduleWrapper.current.values.parameters;
-
 exports.getParameters = getParameters;
-
 const getPages = () => _ChaynsProvider.moduleWrapper.current.values.pages;
-
 exports.getPages = getPages;
-
 const getEnvironment = () => _ChaynsProvider.moduleWrapper.current.values.environment;
-
 exports.getEnvironment = getEnvironment;
 const user = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren;
-
     console.warn('Deprecated user import');
     return (_moduleWrapper$curren = _ChaynsProvider.moduleWrapper.current.values.user) === null || _moduleWrapper$curren === void 0 ? void 0 : _moduleWrapper$curren[prop];
   }
@@ -399,7 +253,6 @@ exports.user = user;
 const site = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren2;
-
     console.warn('Deprecated site import');
     return (_moduleWrapper$curren2 = _ChaynsProvider.moduleWrapper.current.values.site) === null || _moduleWrapper$curren2 === void 0 ? void 0 : _moduleWrapper$curren2[prop];
   }
@@ -408,7 +261,6 @@ exports.site = site;
 const device = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren3;
-
     console.warn('Deprecated device import');
     return (_moduleWrapper$curren3 = _ChaynsProvider.moduleWrapper.current.values.device) === null || _moduleWrapper$curren3 === void 0 ? void 0 : _moduleWrapper$curren3[prop];
   }
@@ -417,7 +269,6 @@ exports.device = device;
 const language = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren4;
-
     console.warn('Deprecated language import');
     return (_moduleWrapper$curren4 = _ChaynsProvider.moduleWrapper.current.values.language) === null || _moduleWrapper$curren4 === void 0 ? void 0 : _moduleWrapper$curren4[prop];
   }
@@ -426,7 +277,6 @@ exports.language = language;
 const parameters = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren5;
-
     console.warn('Deprecated parameters import');
     return (_moduleWrapper$curren5 = _ChaynsProvider.moduleWrapper.current.values.parameters) === null || _moduleWrapper$curren5 === void 0 ? void 0 : _moduleWrapper$curren5[prop];
   }
@@ -435,7 +285,6 @@ exports.parameters = parameters;
 const pages = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren6;
-
     console.warn('Deprecated pages import');
     return (_moduleWrapper$curren6 = _ChaynsProvider.moduleWrapper.current.values.pages) === null || _moduleWrapper$curren6 === void 0 ? void 0 : _moduleWrapper$curren6[prop];
   }
@@ -444,7 +293,6 @@ exports.pages = pages;
 const environment = new Proxy({}, {
   get: (target, prop) => {
     var _moduleWrapper$curren7;
-
     console.warn('Deprecated environment import');
     return (_moduleWrapper$curren7 = _ChaynsProvider.moduleWrapper.current.values.environment) === null || _moduleWrapper$curren7 === void 0 ? void 0 : _moduleWrapper$curren7[prop];
   }

package/dist/cjs/calls/sendMessage.js

@@ -5,35 +5,27 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.sendMessageToUser = exports.sendMessageToPage = exports.sendMessageToGroup = void 0;
 const INTERCOM_URL = 'https://sub54.tobit.com/rest/api';
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
-
 const sendMessageToUser = async (api, object, receiverUserId) => {
   var _api$values$user;
-
   if (!object.text) {
     return Promise.reject(new Error('no text specified'));
   }
-
   const senderUserId = (_api$values$user = api.values.user) === null || _api$values$user === void 0 ? void 0 : _api$values$user.userId;
-
   if (senderUserId === undefined) {
     return Promise.reject(new Error('missing sender user id'));
   }
-
   const {
     accessToken
   } = await api.functions.getAccessToken();
-
   if (!accessToken) {
     return Promise.reject(new Error('send message requires a user to be logged in'));
   }
-
   if (!accessToken) {
     return Promise.reject(new Error('send message requires a user to be logged in'));
   }
-
   const images = Array.isArray(object.images) ? object.images.map(imageUrl => ({
     url: imageUrl
   })) : [];
@@ -48,34 +40,25 @@ const sendMessageToUser = async (api, object, receiverUserId) => {
     }
   });
 };
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
-
-
 exports.sendMessageToUser = sendMessageToUser;
-
 const sendMessageToPage = async (api, object) => {
   var _api$values$user2;
-
   if (!object.text) {
     return Promise.reject(new Error('no text specified'));
   }
-
   const senderUserId = (_api$values$user2 = api.values.user) === null || _api$values$user2 === void 0 ? void 0 : _api$values$user2.userId;
-
   if (senderUserId === undefined) {
     return Promise.reject(new Error('missing sender user id'));
   }
-
   const {
     accessToken
   } = await api.functions.getAccessToken();
-
   if (!accessToken) {
     return Promise.reject(new Error('send message requires a user to be logged in'));
   }
-
   const images = Array.isArray(object.images) ? object.images.map(imageUrl => ({
     url: imageUrl
   })) : [];
@@ -90,29 +73,23 @@ const sendMessageToPage = async (api, object) => {
     }
   });
 };
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
-
-
 exports.sendMessageToPage = sendMessageToPage;
-
 const sendMessageToGroup = async (api, object, groupId) => {
   if (!object.text) {
     return Promise.reject(new Error('no text specified'));
   }
-
   const {
     accessToken
   } = await api.functions.getAccessToken();
   const {
     locationId
   } = api.values.site;
-
   if (!accessToken) {
     return Promise.reject(new Error('send message requires a user to be logged in'));
   }
-
   const images = Array.isArray(object.images) ? object.images.map(imageUrl => ({
     url: imageUrl
   })) : [];
@@ -127,13 +104,10 @@ const sendMessageToGroup = async (api, object, groupId) => {
     }
   });
 };
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
-
-
 exports.sendMessageToGroup = sendMessageToGroup;
-
 function sendMessage(endpoint, token, body) {
   return fetch(`${INTERCOM_URL}${endpoint}`, {
     method: 'POST',