chayns-api 1.0.36 → 1.0.38

package/dist/cjs/calls/index.js

@@ -3,7 +3,7 @@
 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.scrollByY = 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.getCurrentPage = exports.getAvailableSharingServices = exports.getAccessToken = exports.environment = exports.device = exports.customCallbackFunction = exports.createDialog = exports.addWindowMetricsListener = exports.addVisibilityChangeListener = exports.addScrollListener = exports.addGeoLocationListener = void 0;
+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.scrollByY = exports.removeWindowMetricsListener = exports.removeVisibilityChangeListener = exports.removeToolbarChangeListener = exports.removeScrollListener = exports.removeGeoLocationListener = exports.refreshData = exports.refreshAccessToken = exports.parameters = exports.pages = exports.openVideo = exports.openUrl = exports.openMedia = 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.getCurrentPage = exports.getAvailableSharingServices = exports.getAccessToken = exports.environment = exports.device = exports.customCallbackFunction = exports.createDialog = exports.addWindowMetricsListener = exports.addVisibilityChangeListener = exports.addToolbarChangeListener = exports.addScrollListener = exports.addGeoLocationListener = void 0;
 var _moduleWrapper = require("../components/moduleWrapper");
 /**
  * This adds a listener to determine your location.
@@ -23,10 +23,17 @@ const addScrollListener = (...args) => _moduleWrapper.moduleWrapper.current.func
 exports.addScrollListener = addScrollListener;
 const addVisibilityChangeListener = (...args) => _moduleWrapper.moduleWrapper.current.functions.addVisibilityChangeListener(...args);
 /**
- * This adds a listener to get the actual height of the page.
+ * This method will be executed when the toolbar gets displayed or hidden.
  * @category Event listener
  */
 exports.addVisibilityChangeListener = addVisibilityChangeListener;
+const addToolbarChangeListener = (...args) => _moduleWrapper.moduleWrapper.current.functions.addToolbarChangeListener(...args);
+
+/**
+ * This adds a listener to get the actual height of the page.
+ * @category Event listener
+ */
+exports.addToolbarChangeListener = addToolbarChangeListener;
 const addWindowMetricsListener = (...args) => _moduleWrapper.moduleWrapper.current.functions.addWindowMetricsListener(...args); /**
                                                                                                                                 * Allows a custom callback function to be defined
                                                                                                                                 */
@@ -90,9 +97,14 @@ const navigateBack = (...args) => _moduleWrapper.moduleWrapper.current.functions
 exports.navigateBack = navigateBack;
 const openImage = (...args) => _moduleWrapper.moduleWrapper.current.functions.openImage(...args);
 /**
- * Opens an URL in the chayns environment.
+ * The images and videos specified in the items array is shown in gallery mode.
  */
 exports.openImage = openImage;
+const openMedia = (...args) => _moduleWrapper.moduleWrapper.current.functions.openMedia(...args);
+/**
+ * Opens an URL in the chayns environment.
+ */
+exports.openMedia = openMedia;
 const openUrl = (...args) => _moduleWrapper.moduleWrapper.current.functions.openUrl(...args);
 /**
  * The video specified in the URL is shown in video mode.
@@ -116,10 +128,16 @@ const refreshAccessToken = (...args) => _moduleWrapper.moduleWrapper.current.fun
 exports.refreshAccessToken = refreshAccessToken;
 const removeGeoLocationListener = (...args) => _moduleWrapper.moduleWrapper.current.functions.removeGeoLocationListener(...args);
 /**
- * Removes scroll listener.
+ * This removes a listener for changing toolbar visibility
  * @category Event listener
  */
 exports.removeGeoLocationListener = removeGeoLocationListener;
+const removeToolbarChangeListener = (...args) => _moduleWrapper.moduleWrapper.current.functions.removeToolbarChangeListener(...args);
+/**
+ * Removes scroll listener.
+ * @category Event listener
+ */
+exports.removeToolbarChangeListener = removeToolbarChangeListener;
 const removeScrollListener = (...args) => _moduleWrapper.moduleWrapper.current.functions.removeScrollListener(...args);
 /**
  * Removes visibility change listener.

package/dist/cjs/types/IChaynsReact.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ToastType = exports.TappEvent = exports.SharingApp = exports.ScreenSize = exports.ScanQrCodeCodeType = exports.ScanQrCodeCameraTypes = exports.RuntimeEnviroment = exports.Language = exports.IconType = exports.Gender = exports.Font = exports.FloatingButtonPosition = exports.Environment = exports.DialogType = exports.DialogSelectType = exports.DialogInputType = exports.DialogButtonType = exports.DeviceOs = exports.DateType = exports.ColorMode = exports.BrowserName = exports.AppName = exports.AccessMode = void 0;
+exports.ToastType = exports.TappEvent = exports.SharingApp = exports.ScreenSize = exports.ScanQrCodeCodeType = exports.ScanQrCodeCameraTypes = exports.RuntimeEnviroment = exports.MediaType = exports.Language = exports.IconType = exports.Gender = exports.Font = exports.FloatingButtonPosition = exports.Environment = exports.DialogType = exports.DialogSelectType = exports.DialogInputType = exports.DialogButtonType = exports.DeviceOs = exports.DateType = exports.ColorMode = exports.BrowserName = exports.AppName = exports.AccessMode = void 0;
 let DateType = /*#__PURE__*/function (DateType) {
   DateType[DateType["DATE"] = 0] = "DATE";
   DateType[DateType["TIME"] = 1] = "TIME";
@@ -314,4 +314,10 @@ let DialogType = /*#__PURE__*/function (DialogType) {
   DialogType["TOAST"] = "toast";
   return DialogType;
 }({});
-exports.DialogType = DialogType;
+exports.DialogType = DialogType;
+let MediaType = /*#__PURE__*/function (MediaType) {
+  MediaType["IMAGE"] = "image";
+  MediaType["VIDEO"] = "video";
+  return MediaType;
+}({});
+exports.MediaType = MediaType;

package/dist/cjs/wrapper/AppWrapper.js

@@ -211,6 +211,23 @@ class AppWrapper {
       }
       return id;
     },
+    addToolbarChangeListener: async callback => {
+      const {
+        id,
+        shouldInitialize
+      } = (0, _apiListenerHelper.addApiListener)('toolbarChangeListener', callback);
+      if (shouldInitialize) {
+        this.appCall(293, {}, {
+          callback: v => {
+            (0, _apiListenerHelper.dispatchApiEvent)('toolbarChangeListener', {
+              isVisible: v.isVisible,
+              toolbarHeight: v.toolbarHeight
+            });
+          }
+        });
+      }
+      return id;
+    },
     addWindowMetricsListener: async callback => {
       const {
         id,
@@ -275,7 +292,7 @@ class AppWrapper {
       window[callbackName] = ({
         retVal
       }) => {
-        callback === null || callback === void 0 ? void 0 : callback(retVal);
+        callback === null || callback === void 0 || callback(retVal);
         delete window[callbackName];
       };
       const callObj = {
@@ -359,6 +376,14 @@ class AppWrapper {
         // App does not support removal of onActivate callback which makes this a no-op
       }
     },
+    removeToolbarChangeListener: async id => {
+      const {
+        shouldRemove
+      } = (0, _apiListenerHelper.removeApiListener)('toolbarChangeListener', id);
+      if (shouldRemove) {
+        // App does not support removal of onToolbarBarRemove callback which makes this a no-op
+      }
+    },
     removeWindowMetricsListener: async id => {
       const shouldRemove = (0, _apiListenerHelper.removeApiListener)('windowMetricsListener', id);
       if (shouldRemove) {

package/dist/cjs/wrapper/FrameWrapper.js

@@ -34,6 +34,10 @@ class FrameWrapper {
       return this.exposedFunctions.addScrollListener(value, callback && comlink.proxy(result => callback(result)));
     },
     addVisibilityChangeListener: async callback => (0, _visibilityChangeListener.addVisibilityChangeListener)(callback),
+    addToolbarChangeListener: async callback => {
+      if (!this.initialized) await this.ready;
+      return this.exposedFunctions.addToolbarChangeListener(callback && comlink.proxy(result => callback(result)));
+    },
     addWindowMetricsListener: async callback => {
       if (!this.initialized) await this.ready;
       const {
@@ -105,6 +109,10 @@ class FrameWrapper {
       if (!this.initialized) await this.ready;
       return this.exposedFunctions.openImage(value);
     },
+    openMedia: async value => {
+      if (!this.initialized) await this.ready;
+      return this.exposedFunctions.openMedia(value);
+    },
     openUrl: async value => {
       if (!this.initialized) await this.ready;
       return this.exposedFunctions.openUrl(value);
@@ -142,6 +150,10 @@ class FrameWrapper {
         this.resizeListener = null;
       }
     },
+    removeToolbarChangeListener: async id => {
+      if (!this.initialized) await this.ready;
+      return this.exposedFunctions.removeToolbarChangeListener(id);
+    },
     selectPage: async options => {
       if (!this.initialized) await this.ready;
       await this.exposedFunctions.selectPage(options);

package/dist/esm/calls/index.js

@@ -20,6 +20,14 @@ export const addScrollListener = function () {
 export const addVisibilityChangeListener = function () {
   return moduleWrapper.current.functions.addVisibilityChangeListener(...arguments);
 };
+/**
+ * This method will be executed when the toolbar gets displayed or hidden.
+ * @category Event listener
+ */
+export const addToolbarChangeListener = function () {
+  return moduleWrapper.current.functions.addToolbarChangeListener(...arguments);
+};
+
 /**
  * This adds a listener to get the actual height of the page.
  * @category Event listener
@@ -101,6 +109,12 @@ export const navigateBack = function () {
 export const openImage = function () {
   return moduleWrapper.current.functions.openImage(...arguments);
 };
+/**
+ * The images and videos specified in the items array is shown in gallery mode.
+ */
+export const openMedia = function () {
+  return moduleWrapper.current.functions.openMedia(...arguments);
+};
 /**
  * Opens an URL in the chayns environment.
  */
@@ -132,6 +146,13 @@ export const refreshAccessToken = function () {
 export const removeGeoLocationListener = function () {
   return moduleWrapper.current.functions.removeGeoLocationListener(...arguments);
 };
+/**
+ * This removes a listener for changing toolbar visibility
+ * @category Event listener
+ */
+export const removeToolbarChangeListener = function () {
+  return moduleWrapper.current.functions.removeToolbarChangeListener(...arguments);
+};
 /**
  * Removes scroll listener.
  * @category Event listener

package/dist/esm/types/IChaynsReact.js

@@ -288,4 +288,9 @@ export let DialogType = /*#__PURE__*/function (DialogType) {
   DialogType["SELECT"] = "select";
   DialogType["TOAST"] = "toast";
   return DialogType;
+}({});
+export let MediaType = /*#__PURE__*/function (MediaType) {
+  MediaType["IMAGE"] = "image";
+  MediaType["VIDEO"] = "video";
+  return MediaType;
 }({});

package/dist/esm/wrapper/AppWrapper.js

@@ -166,6 +166,23 @@ export class AppWrapper {
         }
         return id;
       },
+      addToolbarChangeListener: async callback => {
+        const {
+          id,
+          shouldInitialize
+        } = addApiListener('toolbarChangeListener', callback);
+        if (shouldInitialize) {
+          this.appCall(293, {}, {
+            callback: v => {
+              dispatchApiEvent('toolbarChangeListener', {
+                isVisible: v.isVisible,
+                toolbarHeight: v.toolbarHeight
+              });
+            }
+          });
+        }
+        return id;
+      },
       addWindowMetricsListener: async callback => {
         const {
           id,
@@ -231,7 +248,7 @@ export class AppWrapper {
           let {
             retVal
           } = _ref;
-          callback === null || callback === void 0 ? void 0 : callback(retVal);
+          callback === null || callback === void 0 || callback(retVal);
           delete window[callbackName];
         };
         const callObj = {
@@ -315,6 +332,14 @@ export class AppWrapper {
           // App does not support removal of onActivate callback which makes this a no-op
         }
       },
+      removeToolbarChangeListener: async id => {
+        const {
+          shouldRemove
+        } = removeApiListener('toolbarChangeListener', id);
+        if (shouldRemove) {
+          // App does not support removal of onToolbarBarRemove callback which makes this a no-op
+        }
+      },
       removeWindowMetricsListener: async id => {
         const shouldRemove = removeApiListener('windowMetricsListener', id);
         if (shouldRemove) {

package/dist/esm/wrapper/FrameWrapper.js

@@ -28,6 +28,10 @@ export class FrameWrapper {
         return this.exposedFunctions.addScrollListener(value, callback && comlink.proxy(result => callback(result)));
       },
       addVisibilityChangeListener: async callback => addVisibilityChangeListener(callback),
+      addToolbarChangeListener: async callback => {
+        if (!this.initialized) await this.ready;
+        return this.exposedFunctions.addToolbarChangeListener(callback && comlink.proxy(result => callback(result)));
+      },
       addWindowMetricsListener: async callback => {
         if (!this.initialized) await this.ready;
         const {
@@ -99,6 +103,10 @@ export class FrameWrapper {
         if (!this.initialized) await this.ready;
         return this.exposedFunctions.openImage(value);
       },
+      openMedia: async value => {
+        if (!this.initialized) await this.ready;
+        return this.exposedFunctions.openMedia(value);
+      },
       openUrl: async value => {
         if (!this.initialized) await this.ready;
         return this.exposedFunctions.openUrl(value);
@@ -136,6 +144,10 @@ export class FrameWrapper {
           this.resizeListener = null;
         }
       },
+      removeToolbarChangeListener: async id => {
+        if (!this.initialized) await this.ready;
+        return this.exposedFunctions.removeToolbarChangeListener(id);
+      },
       selectPage: async options => {
         if (!this.initialized) await this.ready;
         await this.exposedFunctions.selectPage(options);

package/dist/types/calls/index.d.ts

@@ -19,6 +19,11 @@ export declare const addScrollListener: (value: {
  * @category Event listener
  */
 export declare const addVisibilityChangeListener: (callback: (result: import("../types/IChaynsReact").VisibilityChangeListenerResult) => void) => Promise<number>;
+/**
+ * This method will be executed when the toolbar gets displayed or hidden.
+ * @category Event listener
+ */
+export declare const addToolbarChangeListener: (callback: (result: import("../types/IChaynsReact").ToolbarChangeListenerResult) => void) => Promise<number>;
 /**
  * This adds a listener to get the actual height of the page.
  * @category Event listener
@@ -75,6 +80,10 @@ export declare const navigateBack: () => Promise<void>;
  * The images specified in the url array is shown in gallery mode.
  */
 export declare const openImage: (value: import("../types/IChaynsReact").OpenImage) => Promise<void>;
+/**
+ * The images and videos specified in the items array is shown in gallery mode.
+ */
+export declare const openMedia: (value: import("../types/IChaynsReact").OpenMedia) => Promise<void>;
 /**
  * Opens an URL in the chayns environment.
  */
@@ -96,6 +105,11 @@ export declare const refreshAccessToken: () => Promise<void>;
  * @category Event listener
  */
 export declare const removeGeoLocationListener: (value: number) => Promise<void>;
+/**
+ * This removes a listener for changing toolbar visibility
+ * @category Event listener
+ */
+export declare const removeToolbarChangeListener: (value: number) => Promise<void>;
 /**
  * Removes scroll listener.
  * @category Event listener

package/dist/types/types/IChaynsReact.d.ts

@@ -212,6 +212,7 @@ export interface ChaynsReactFunctions {
         throttle?: number;
     }, callback: (result: ScrollListenerResult) => void) => Promise<number>;
     addVisibilityChangeListener: (callback: (result: VisibilityChangeListenerResult) => void) => Promise<number>;
+    addToolbarChangeListener: (callback: (result: ToolbarChangeListenerResult) => void) => Promise<number>;
     addWindowMetricsListener: (callback: (result: WindowMetricsListenerResult) => void) => Promise<number>;
     customCallbackFunction: (type: string, data: unknown) => Promise<unknown>;
     getAvailableSharingServices: () => Promise<AvailableSharingServices>;
@@ -231,11 +232,13 @@ export interface ChaynsReactFunctions {
     openImage: (value: OpenImage) => Promise<void>;
     openUrl: (value: OpenUrl) => Promise<void>;
     openVideo: (value: OpenVideo) => Promise<void>;
+    openMedia: (value: OpenMedia) => Promise<void>;
     refreshData: (value: RefreshData) => Promise<void>;
     refreshAccessToken: () => Promise<void>;
     removeGeoLocationListener: (value: number) => Promise<void>;
     removeScrollListener: (value: number) => Promise<void>;
     removeVisibilityChangeListener: (value: number) => Promise<void>;
+    removeToolbarChangeListener: (value: number) => Promise<void>;
     removeWindowMetricsListener: (value: number) => Promise<void>;
     selectPage: (value: SelectPage) => Promise<void>;
     scrollToY: (position: number, duration: number) => Promise<void>;
@@ -487,7 +490,7 @@ export type UserInfoQuery = {
     personId?: string;
     userId: number;
 };
-type OpenImageItem = {
+export type OpenImageItem = {
     url: string;
     title?: string;
     description?: string;
@@ -611,6 +614,10 @@ export interface VisibilityChangeListenerResult {
     isVisible: boolean;
     tappEvent: TappEvent;
 }
+export interface ToolbarChangeListenerResult {
+    isVisible: boolean;
+    toolbarHeight: number;
+}
 export interface ScrollListenerResult {
     scrollX: number | null;
     scrollY: number | null;
@@ -763,4 +770,19 @@ export declare enum DialogType {
     SELECT = "select",
     TOAST = "toast"
 }
+export declare enum MediaType {
+    IMAGE = "image",
+    VIDEO = "video"
+}
+export type OpenMediaItem = {
+    url: string;
+    title?: string;
+    description?: string;
+    preventCache?: boolean;
+    mediaType: MediaType;
+};
+export type OpenMedia = {
+    items: [OpenMediaItem, ...OpenMediaItem[]];
+    startIndex?: number;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "chayns-api",
-    "version": "1.0.36",
+    "version": "1.0.38",
     "description": "new chayns api",
     "main": "dist/cjs/index.js",
     "module": "dist/esm/index.js",