chayns-api 1.0.2 → 1.0.4

package/dist/cjs/util/deviceHelper.js

@@ -17,7 +17,7 @@ const getDeviceInfo = (userAgent, acceptHeader) => {
     appName = _IChaynsReact.AppName.David;
   } else if (match) {
     appName = _IChaynsReact.AppName.Location;
-  } else if (/dface|h96pp|h96max|jabiru|chaynsterminal|wayter|odroidn2p/i.test(navigator.userAgent)) {
+  } else if (/dface|h96pp|h96max|jabiru|chaynsterminal|wayter|odroidn2p/i.test(userAgent)) {
     appName = _IChaynsReact.AppName.ChaynsLauncher;
   }
   const result = {};

package/dist/cjs/wrapper/AppWrapper.js

@@ -308,6 +308,11 @@ class AppWrapper {
         top: position
       });
     },
+    scrollByY: (value, duration) => {
+      window.scrollBy({
+        top: value
+      });
+    },
     sendMessageToGroup: async (groupId, message) => {
       return (0, _sendMessage.sendMessageToGroup)(this, message, groupId);
     },

package/dist/cjs/wrapper/FrameWrapper.js

@@ -229,6 +229,10 @@ class FrameWrapper {
     vibrate: async value => {
       if (!this.initialized) await this.ready;
       return this.exposedFunctions.vibrate(value);
+    },
+    scrollByY: async (value, duration) => {
+      if (!this.initialized) await this.ready;
+      return this.exposedFunctions.scrollByY(value, duration);
     }
   };
   initialized = false;

package/dist/esm/calls/dialogs/date.js

@@ -3,32 +3,32 @@ import { isDate, isNumber, isObject } from './utils/is';
 import { open } from './open';
 import { getDevice } from "../index";
 
-/**
- * The config object for date dialog
- * @typedef {Object} dateConfig
- * @property {Date} preSelect  - The date object which should be preselected.
- * @property {Date} minDate   - The min date which you could select.
- * @property {Date} maxDate  - The max date which you could select.
- * @property {dateDialogType} dateType  - The type of dialog you want to display.
- * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
- * @property {string} message - The message that is displayed above the date dialog, only in apps supported
- * @property {string} title - The title that is displayed above the message, only in apps supported
+/**
+ * The config object for date dialog
+ * @typedef {Object} dateConfig
+ * @property {Date} preSelect  - The date object which should be preselected.
+ * @property {Date} minDate   - The min date which you could select.
+ * @property {Date} maxDate  - The max date which you could select.
+ * @property {dateDialogType} dateType  - The type of dialog you want to display.
+ * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
+ * @property {string} message - The message that is displayed above the date dialog, only in apps supported
+ * @property {string} title - The title that is displayed above the message, only in apps supported
  */
 
-/**
- * This call will open a date select dialog.
- * <div>Call: 30</div>
- * @param {dateConfig} config - Define the configuration of this call
- * @return {Promise} contains a timestamp as result
- * @example chayns.dialog.date({
- *  'dateType': chayns.dialog.dateType.DATE_TIME,
- *  'preSelect': new Date(2018, 6, 14, 0, 0, 0),
- *  'minDate':  new Date(2018, 6, 1, 15, 0, 0),
- *  'maxDate': new Date(2019, 6, 1, 0, 23, 0),
- *  'minuteInterval': 15
- * ).then(function (data) {
- *  console.log(data);
- * });
+/**
+ * This call will open a date select dialog.
+ * <div>Call: 30</div>
+ * @param {dateConfig} config - Define the configuration of this call
+ * @return {Promise} contains a timestamp as result
+ * @example chayns.dialog.date({
+ *  'dateType': chayns.dialog.dateType.DATE_TIME,
+ *  'preSelect': new Date(2018, 6, 14, 0, 0, 0),
+ *  'minDate':  new Date(2018, 6, 1, 15, 0, 0),
+ *  'maxDate': new Date(2019, 6, 1, 0, 23, 0),
+ *  'minuteInterval': 15
+ * ).then(function (data) {
+ *  console.log(data);
+ * });
  */
 
 export function date() {
@@ -165,18 +165,18 @@ export function advancedDate() {
   });
 }
 
-/**
- * @typedef {number} dateDialogType
+/**
+ * @typedef {number} dateDialogType
  */
 
-/**
- * Enum for date dialog
- * <div>DATE will open a dialog where you can select a special day</div>
- * <div>TIME will open a dialog where you can only select a special time</div>
- * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
- * @readonly
- * @enum {dateDialogType}
- * @type {{DATE: number, TIME: number, DATE_TIME: number}}
+/**
+ * Enum for date dialog
+ * <div>DATE will open a dialog where you can select a special day</div>
+ * <div>TIME will open a dialog where you can only select a special time</div>
+ * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
+ * @readonly
+ * @enum {dateDialogType}
+ * @type {{DATE: number, TIME: number, DATE_TIME: number}}
  */
 export const dateType = {
   'DATE': 1,

package/dist/esm/calls/index.js

@@ -1,70 +1,70 @@
 import { moduleWrapper } from '../components/ChaynsProvider';
-/**
- * This adds a listener to determine your location.
- * @category Event listener
+/**
+ * This adds a listener to determine your location.
+ * @category Event listener
  */
 export const addGeoLocationListener = function () {
   return moduleWrapper.current.functions.addGeoLocationListener(...arguments);
 };
-/**
- * Adds a listener for scroll event by user.
- * @category Event listener
+/**
+ * Adds a listener for scroll event by user.
+ * @category Event listener
  */
 export const addScrollListener = function () {
   return moduleWrapper.current.functions.addScrollListener(...arguments);
 };
-/**
- * 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
  */
 export const addVisibilityChangeListener = function () {
   return moduleWrapper.current.functions.addVisibilityChangeListener(...arguments);
 };
-/**
- * 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
  */
 export const addWindowMetricsListener = function () {
   return moduleWrapper.current.functions.addWindowMetricsListener(...arguments);
-}; /**
-   * Allows a custom callback function to be defined
+}; /**
+   * Allows a custom callback function to be defined
    */
 export const customCallbackFunction = function () {
   return moduleWrapper.current.functions.customCallbackFunction(...arguments);
 };
-/**
- * Get the accessToken from the user.
+/**
+ * Get the accessToken from the user.
  */
 export const getAccessToken = function () {
   return moduleWrapper.current.functions.getAccessToken(...arguments);
 };
-/**
- * This method returns a list of installed share/social media apps.
+/**
+ * This method returns a list of installed share/social media apps.
  */
 export const getAvailableSharingServices = function () {
   return moduleWrapper.current.functions.getAvailableSharingServices(...arguments);
 };
-/**
- * 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.
  */
 export const getGeoLocation = function () {
   return moduleWrapper.current.functions.getGeoLocation(...arguments);
 };
-/**
- * This method returns user information for a specific user.
- * @category User functions
+/**
+ * This method returns user information for a specific user.
+ * @category User functions
  */
 export const getUserInfo = function () {
   return moduleWrapper.current.functions.getUserInfo(...arguments);
 };
-/**
- * Return the current scroll position of the top frame
+/**
+ * Return the current scroll position of the top frame
  */
 export const getScrollPosition = function () {
   return moduleWrapper.current.functions.getScrollPosition(...arguments);
 };
-/**
- * Returns the window metrics.
+/**
+ * Returns the window metrics.
  */
 export const getWindowMetrics = function () {
   return moduleWrapper.current.functions.getWindowMetrics(...arguments);
@@ -77,193 +77,199 @@ export const invokeCall = function () {
 export const invokeDialogCall = function () {
   return moduleWrapper.current.functions.invokeDialogCall(...arguments);
 };
-/**
- * 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.
  */
 export const login = function () {
   return moduleWrapper.current.functions.login(...arguments);
 };
-/**
- * This method will logout the user
+/**
+ * This method will logout the user
  */
 export const logout = function () {
   return moduleWrapper.current.functions.logout(...arguments);
 };
-/**
- * This function navigates you to the previous site.
+/**
+ * This function navigates you to the previous site.
  */
 export const navigateBack = function () {
   return moduleWrapper.current.functions.navigateBack(...arguments);
 };
-/**
- * The images specified in the url array is shown in gallery mode.
+/**
+ * The images specified in the url array is shown in gallery mode.
  */
 export const openImage = function () {
   return moduleWrapper.current.functions.openImage(...arguments);
 };
-/**
- * Opens an URL in the chayns environment.
+/**
+ * Opens an URL in the chayns environment.
  */
 export const openUrl = function () {
   return moduleWrapper.current.functions.openUrl(...arguments);
 };
-/**
- * The video specified in the URL is shown in video mode.
+/**
+ * The video specified in the URL is shown in video mode.
  */
 export const openVideo = function () {
   return moduleWrapper.current.functions.openVideo(...arguments);
 };
-/**
- * Refresh badge count in navigation, user information and pages
+/**
+ * Refresh badge count in navigation, user information and pages
  */
 export const refreshData = function () {
   return moduleWrapper.current.functions.refreshData(...arguments);
 };
-/**
- * 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
  */
 export const refreshAccessToken = function () {
   return moduleWrapper.current.functions.refreshAccessToken(...arguments);
 };
-/**
- * This removes a listener to determine your location.
- * @category Event listener
+/**
+ * This removes a listener to determine your location.
+ * @category Event listener
  */
 export const removeGeoLocationListener = function () {
   return moduleWrapper.current.functions.removeGeoLocationListener(...arguments);
 };
-/**
- * Removes scroll listener.
- * @category Event listener
+/**
+ * Removes scroll listener.
+ * @category Event listener
  */
 export const removeScrollListener = function () {
   return moduleWrapper.current.functions.removeScrollListener(...arguments);
 };
-/**
- * Removes visibility change listener.
- * @category Event listener
+/**
+ * Removes visibility change listener.
+ * @category Event listener
  */
 export const removeVisibilityChangeListener = function () {
   return moduleWrapper.current.functions.removeVisibilityChangeListener(...arguments);
 };
-/**
- * Removes window metrics listener.
- * @category Event listener
+/**
+ * Removes window metrics listener.
+ * @category Event listener
  */
 export const removeWindowMetricsListener = function () {
   return moduleWrapper.current.functions.removeWindowMetricsListener(...arguments);
 };
-/**
- * Select other page on chayns site.
+/**
+ * Select other page on chayns site.
  */
 export const selectPage = function () {
   return moduleWrapper.current.functions.selectPage(...arguments);
 };
-/**
- * Scrolls to specific position.
+/**
+ * Scrolls by specific amount.
+ */
+export const scrollByY = function () {
+  return moduleWrapper.current.functions.scrollByY(...arguments);
+};
+/**
+ * Scrolls to specific position.
  */
 export const scrollToY = function () {
   return moduleWrapper.current.functions.scrollToY(...arguments);
 };
-/**
- * Sends intercom message to group.
+/**
+ * Sends intercom message to group.
  */
 export const sendMessageToGroup = function () {
   return moduleWrapper.current.functions.sendMessageToGroup(...arguments);
 };
-/**
- * Sends intercom message to page.
+/**
+ * Sends intercom message to page.
  */
 export const sendMessageToPage = function () {
   return moduleWrapper.current.functions.sendMessageToPage(...arguments);
 };
-/**
- * Sends intercom message to an user.
+/**
+ * Sends intercom message to an user.
  */
 export const sendMessageToUser = function () {
   return moduleWrapper.current.functions.sendMessageToUser(...arguments);
 };
-/**
- * Switches admin mode, also toggles admin switch in top frame.
+/**
+ * Switches admin mode, also toggles admin switch in top frame.
  */
 export const setAdminMode = function () {
   return moduleWrapper.current.functions.setAdminMode(...arguments);
 };
-/**
- * Sets the display timeout, only works in chayns App.
+/**
+ * Sets the display timeout, only works in chayns App.
  */
 export const setDisplayTimeout = function () {
   return moduleWrapper.current.functions.setDisplayTimeout(...arguments);
 };
-/**
- * Enables or disables a button which floats over the page.
+/**
+ * Enables or disables a button which floats over the page.
  */
 export const setFloatingButton = function () {
   return moduleWrapper.current.functions.setFloatingButton(...arguments);
 };
-/**
- * Sets the height of the page.
+/**
+ * Sets the height of the page.
  */
 export const setHeight = function () {
   return moduleWrapper.current.functions.setHeight(...arguments);
 };
-/**
- * Enables or disables the ability to refresh a page
+/**
+ * Enables or disables the ability to refresh a page
  */
 export const setRefreshScrollEnabled = function () {
   return moduleWrapper.current.functions.setRefreshScrollEnabled(...arguments);
 };
-/**
- * Scans a qr-code and returns the result
+/**
+ * Scans a qr-code and returns the result
  */
 export const setScanQrCode = function () {
   return moduleWrapper.current.functions.setScanQrCode(...arguments);
 };
-/**
- * Temporarily change design settings in top frame
+/**
+ * Temporarily change design settings in top frame
  */
 export const setTempDesignSettings = function () {
   return moduleWrapper.current.functions.setTempDesignSettings(...arguments);
 };
-/**
- * Shows or hide a waitcursor
+/**
+ * Shows or hide a waitcursor
  */
 export const setWaitCursor = function () {
   return moduleWrapper.current.functions.setWaitCursor(...arguments);
 };
-/**
- * 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
  */
 export const storageGetItem = function () {
   return moduleWrapper.current.functions.storageGetItem(...arguments);
 };
-/**
- * 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
  */
 export const storageRemoveItem = function () {
   return moduleWrapper.current.functions.storageRemoveItem(...arguments);
 };
-/**
- * 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
  */
 export const storageSetItem = function () {
   return moduleWrapper.current.functions.storageSetItem(...arguments);
 };
-/**
- * This method lets a smartphone vibrate for the given time.
+/**
+ * This method lets a smartphone vibrate for the given time.
  */
 export const vibrate = function () {
   return moduleWrapper.current.functions.vibrate(...arguments);
 };
-/**
- * Displays an overlay
+/**
+ * Displays an overlay
  */
 export const setOverlay = function () {
   return moduleWrapper.current.functions.setOverlay(...arguments);
 };
-/**
- * Returns user information, only when user is logged in
- * @category User functions
+/**
+ * Returns user information, only when user is logged in
+ * @category User functions
  */
 export const getUser = () => moduleWrapper.current.values.user;
 export const getSite = () => moduleWrapper.current.values.site;

package/dist/esm/calls/sendMessage.js

@@ -1,6 +1,6 @@
 const INTERCOM_URL = 'https://sub54.tobit.com/rest/api';
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
 export const sendMessageToUser = async (api, object, receiverUserId) => {
   var _api$values$user;
@@ -34,8 +34,8 @@ export const sendMessageToUser = async (api, object, receiverUserId) => {
     }
   });
 };
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
 export const sendMessageToPage = async (api, object) => {
   var _api$values$user2;
@@ -66,8 +66,8 @@ export const sendMessageToPage = async (api, object) => {
     }
   });
 };
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
 export const sendMessageToGroup = async (api, object, groupId) => {
   if (!object.text) {
@@ -96,8 +96,8 @@ export const sendMessageToGroup = async (api, object, groupId) => {
     }
   });
 };
-/**
- * @category Intercom functions
+/**
+ * @category Intercom functions
  */
 function sendMessage(endpoint, token, body) {
   return fetch(`${INTERCOM_URL}${endpoint}`, {

package/dist/esm/calls/visibilityChangeListener.js

@@ -6,8 +6,8 @@ const handleVisibilityChange = () => {
   });
 };
 
-/**
- * @category Event listener
+/**
+ * @category Event listener
  */
 export const addVisibilityChangeListener = callback => {
   const {
@@ -19,8 +19,8 @@ export const addVisibilityChangeListener = callback => {
   }
   return id;
 };
-/**
- * @category Event listener
+/**
+ * @category Event listener
  */
 export const removeVisibilityChangeListener = id => {
   const shouldRemove = removeApiListener(key, id);

package/dist/esm/hooks/geoLocationListener.js

@@ -1,8 +1,8 @@
 import { useContextSelector } from 'use-context-selector';
 import { useCallback, useEffect, useRef, useState } from 'react';
 import { ChaynsFunctionsContext } from '../components/ChaynsContext';
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useGeoLocationListener = () => {
   const addListener = useContextSelector(ChaynsFunctionsContext, v => v.addGeoLocationListener);
@@ -17,8 +17,8 @@ export const useGeoLocationListener = () => {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 };
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useGeoLocation = function () {
   let {

package/dist/esm/hooks/scrollListener.js

@@ -2,8 +2,8 @@ import { useContextSelector } from 'use-context-selector';
 import { useCallback, useEffect, useRef, useState } from 'react';
 import { ChaynsFunctionsContext } from '../components/ChaynsContext';
 import { useWindowMetrics } from './windowMetricsListener';
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useScrollListener = () => {
   const addListener = useContextSelector(ChaynsFunctionsContext, v => v.addScrollListener);
@@ -18,8 +18,8 @@ export const useScrollListener = () => {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 };
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useScrollPosition = function () {
   let {
@@ -46,8 +46,8 @@ export const useScrollPosition = function () {
   }, [getScrollPosition]);
   return value;
 };
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useScrollOffsetTop = function () {
   let {
@@ -69,8 +69,8 @@ export const useScrollOffsetTop = function () {
   }
   return 0;
 };
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useScrollOffsetBottom = function () {
   let {

package/dist/esm/hooks/useAccessToken.js

@@ -2,8 +2,8 @@ import { useEffect, useState } from "react";
 import { useContextSelector } from "use-context-selector";
 import { ChaynsFunctionsContext } from "../components/ChaynsContext";
 
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useAccessToken = accessToken => {
   const [token, setToken] = useState(null);

package/dist/esm/hooks/useCurrentPage.js

@@ -1,7 +1,7 @@
 import { useContextSelector } from 'use-context-selector';
 import { ChaynsContext } from '../components/ChaynsContext';
 
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useCurrentPage = () => useContextSelector(ChaynsContext, v => v === null || v === void 0 ? void 0 : v.currentPage);

package/dist/esm/hooks/useCustomData.js

@@ -1,7 +1,7 @@
 import { useContextSelector } from 'use-context-selector';
 import { ChaynsContext } from '../components/ChaynsContext';
 
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useCustomData = () => useContextSelector(ChaynsContext, v => v === null || v === void 0 ? void 0 : v.customData);

package/dist/esm/hooks/useDevice.js

@@ -1,6 +1,6 @@
 import { useContextSelector } from 'use-context-selector';
 import { ChaynsContext } from '../components/ChaynsContext';
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useDevice = () => useContextSelector(ChaynsContext, v => v === null || v === void 0 ? void 0 : v.device);

package/dist/esm/hooks/useEnvironment.js

@@ -1,6 +1,6 @@
 import { useContextSelector } from 'use-context-selector';
 import { ChaynsContext } from '../components/ChaynsContext';
-/**
- * @category Hooks
+/**
+ * @category Hooks
  */
 export const useEnvironment = () => useContextSelector(ChaynsContext, v => v === null || v === void 0 ? void 0 : v.environment);