chayns-api 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/.babelrc +30 -30
  2. package/.eslintrc +17 -17
  3. package/.github/workflows/deploy_docs.yml +28 -28
  4. package/.github/workflows/publish.yml +21 -0
  5. package/LICENSE +21 -21
  6. package/README.md +47 -47
  7. package/dist/cjs/calls/dialogs/date.js +10 -10
  8. package/dist/cjs/calls/index.js +94 -94
  9. package/dist/cjs/calls/sendMessage.js +8 -8
  10. package/dist/cjs/calls/visibilityChangeListener.js +4 -4
  11. package/dist/cjs/hooks/geoLocationListener.js +4 -4
  12. package/dist/cjs/hooks/scrollListener.js +8 -8
  13. package/dist/cjs/hooks/useAccessToken.js +2 -2
  14. package/dist/cjs/hooks/useCurrentPage.js +2 -2
  15. package/dist/cjs/hooks/useCustomData.js +2 -2
  16. package/dist/cjs/hooks/useDevice.js +2 -2
  17. package/dist/cjs/hooks/useEnvironment.js +2 -2
  18. package/dist/cjs/hooks/useFunctions.js +2 -2
  19. package/dist/cjs/hooks/useIsAdminMode.js +2 -2
  20. package/dist/cjs/hooks/useLanguage.js +2 -2
  21. package/dist/cjs/hooks/usePages.js +4 -4
  22. package/dist/cjs/hooks/useParameters.js +2 -2
  23. package/dist/cjs/hooks/useSite.js +2 -2
  24. package/dist/cjs/hooks/useUser.js +2 -2
  25. package/dist/cjs/hooks/useValues.js +2 -2
  26. package/dist/cjs/hooks/windowMetricsListener.js +4 -4
  27. package/dist/cjs/util/deviceHelper.js +1 -1
  28. package/dist/cjs/wrapper/AppWrapper.js +5 -0
  29. package/dist/cjs/wrapper/FrameWrapper.js +4 -0
  30. package/dist/esm/calls/dialogs/date.js +34 -34
  31. package/dist/esm/calls/index.js +94 -94
  32. package/dist/esm/calls/sendMessage.js +8 -8
  33. package/dist/esm/calls/visibilityChangeListener.js +4 -4
  34. package/dist/esm/hooks/geoLocationListener.js +4 -4
  35. package/dist/esm/hooks/scrollListener.js +8 -8
  36. package/dist/esm/hooks/useAccessToken.js +2 -2
  37. package/dist/esm/hooks/useCurrentPage.js +2 -2
  38. package/dist/esm/hooks/useCustomData.js +2 -2
  39. package/dist/esm/hooks/useDevice.js +2 -2
  40. package/dist/esm/hooks/useEnvironment.js +2 -2
  41. package/dist/esm/hooks/useFunctions.js +2 -2
  42. package/dist/esm/hooks/useIsAdminMode.js +2 -2
  43. package/dist/esm/hooks/useLanguage.js +2 -2
  44. package/dist/esm/hooks/usePages.js +4 -4
  45. package/dist/esm/hooks/useParameters.js +2 -2
  46. package/dist/esm/hooks/useSite.js +2 -2
  47. package/dist/esm/hooks/useUser.js +2 -2
  48. package/dist/esm/hooks/useValues.js +2 -2
  49. package/dist/esm/hooks/windowMetricsListener.js +4 -4
  50. package/dist/esm/util/deviceHelper.js +1 -1
  51. package/dist/esm/wrapper/AppWrapper.js +5 -0
  52. package/dist/esm/wrapper/FrameWrapper.js +4 -0
  53. package/dist/types/calls/dialogs/alert.d.ts +1 -1
  54. package/dist/types/calls/dialogs/chaynsDialog.d.ts +24 -24
  55. package/dist/types/calls/dialogs/close.d.ts +1 -1
  56. package/dist/types/calls/dialogs/communication.d.ts +3 -3
  57. package/dist/types/calls/dialogs/confirm.d.ts +13 -13
  58. package/dist/types/calls/dialogs/date.d.ts +96 -96
  59. package/dist/types/calls/dialogs/dropUpAlert.d.ts +5 -5
  60. package/dist/types/calls/dialogs/fileSelect.d.ts +16 -16
  61. package/dist/types/calls/dialogs/iFrame.d.ts +10 -10
  62. package/dist/types/calls/dialogs/index.d.ts +14 -14
  63. package/dist/types/calls/dialogs/input.d.ts +15 -15
  64. package/dist/types/calls/dialogs/mediaSelect.d.ts +8 -8
  65. package/dist/types/calls/dialogs/open.d.ts +1 -1
  66. package/dist/types/calls/dialogs/select.d.ts +6 -6
  67. package/dist/types/calls/dialogs/signature.d.ts +7 -7
  68. package/dist/types/calls/dialogs/toast.d.ts +1 -1
  69. package/dist/types/calls/dialogs/utils/callback.d.ts +1 -1
  70. package/dist/types/calls/dialogs/utils/is.d.ts +4 -4
  71. package/dist/types/calls/getUserInfo.d.ts +9 -9
  72. package/dist/types/calls/index.d.ts +225 -225
  73. package/dist/types/calls/sendMessage.d.ts +13 -13
  74. package/dist/types/calls/visibilityChangeListener.d.ts +9 -9
  75. package/dist/types/components/ChaynsContext.d.ts +3 -3
  76. package/dist/types/components/ChaynsProvider.d.ts +13 -13
  77. package/dist/types/components/WaitUntil.d.ts +7 -7
  78. package/dist/types/components/withCompatMode.d.ts +13 -13
  79. package/dist/types/helper/apiListenerHelper.d.ts +6 -6
  80. package/dist/types/hooks/geoLocationListener.d.ts +18 -18
  81. package/dist/types/hooks/index.d.ts +16 -16
  82. package/dist/types/hooks/scrollListener.d.ts +28 -28
  83. package/dist/types/hooks/useAccessToken.d.ts +5 -5
  84. package/dist/types/hooks/useCurrentPage.d.ts +4 -4
  85. package/dist/types/hooks/useCustomData.d.ts +4 -4
  86. package/dist/types/hooks/useDevice.d.ts +5 -5
  87. package/dist/types/hooks/useEnvironment.d.ts +5 -5
  88. package/dist/types/hooks/useFunctions.d.ts +5 -5
  89. package/dist/types/hooks/useIsAdminMode.d.ts +4 -4
  90. package/dist/types/hooks/useLanguage.d.ts +5 -5
  91. package/dist/types/hooks/usePages.d.ts +18 -18
  92. package/dist/types/hooks/useParameters.d.ts +5 -5
  93. package/dist/types/hooks/useSite.d.ts +5 -5
  94. package/dist/types/hooks/useUser.d.ts +5 -5
  95. package/dist/types/hooks/useValues.d.ts +5 -5
  96. package/dist/types/hooks/windowMetricsListener.d.ts +11 -11
  97. package/dist/types/host/ChaynsHost.d.ts +28 -28
  98. package/dist/types/host/iframe/HostIframe.d.ts +24 -24
  99. package/dist/types/host/iframe/utils/useUpdateData.d.ts +3 -3
  100. package/dist/types/host/module/ModuleHost.d.ts +23 -23
  101. package/dist/types/host/module/utils/loadComponent.d.ts +1 -1
  102. package/dist/types/host/module/utils/useDynamicScript.d.ts +9 -9
  103. package/dist/types/index.d.ts +16 -16
  104. package/dist/types/types/IChaynsReact.d.ts +622 -621
  105. package/dist/types/types/dialog.d.ts +41 -41
  106. package/dist/types/util/appCall.d.ts +2 -2
  107. package/dist/types/util/deviceHelper.d.ts +7 -7
  108. package/dist/types/util/heightHelper.d.ts +1 -1
  109. package/dist/types/util/postIframeForm.d.ts +1 -1
  110. package/dist/types/wrapper/AppWrapper.d.ts +18 -18
  111. package/dist/types/wrapper/FrameWrapper.d.ts +15 -15
  112. package/dist/types/wrapper/ModuleFederationWrapper.d.ts +10 -10
  113. package/dist/types/wrapper/SsrWrapper.d.ts +11 -11
  114. package/package.json +76 -76
  115. package/toolkit.config.js +52 -52
  116. package/tsconfig.json +56 -56
  117. package/dist/cjs/calls/dialogs/utils/environment.js +0 -10
  118. package/dist/cjs/client.js +0 -93
  119. package/dist/cjs/components/ChaynsModuleProvider.js +0 -457
  120. package/dist/cjs/host/module/PagemakerFrame.js +0 -105
  121. package/dist/cjs/types/DynamicApiImport.d.js +0 -5
  122. package/dist/esm/calls/dialogs/utils/environment.js +0 -3
  123. package/dist/esm/client.js +0 -8
  124. package/dist/esm/components/ChaynsModuleProvider.js +0 -517
  125. package/dist/esm/host/module/PagemakerFrame.js +0 -97
  126. package/dist/esm/types/DynamicApiImport.d.js +0 -1
  127. package/dist/types/calls/dialogs/utils/environment.d.ts +0 -3
  128. package/dist/types/client.d.ts +0 -7
  129. package/dist/types/components/ChaynsModuleProvider.d.ts +0 -170
  130. package/dist/types/host/module/PagemakerFrame.d.ts +0 -22
package/.babelrc CHANGED
@@ -1,30 +1,30 @@
1
- {
2
- "env": {
3
- "esm": {
4
- "presets": [
5
- [
6
- "@babel/preset-env",
7
- {
8
- "targets": ">0.5%, not dead, not op_mini all, chrome 71",
9
- "modules": false
10
- }
11
- ],
12
- "@babel/preset-react",
13
- "@babel/preset-typescript"
14
- ]
15
- },
16
- "cjs": {
17
- "presets": [
18
- [
19
- "@babel/preset-env",
20
- {
21
- "targets": { "node": 12 },
22
- "modules": "commonjs"
23
- }
24
- ],
25
- "@babel/preset-react",
26
- "@babel/preset-typescript"
27
- ]
28
- }
29
- }
30
- }
1
+ {
2
+ "env": {
3
+ "esm": {
4
+ "presets": [
5
+ [
6
+ "@babel/preset-env",
7
+ {
8
+ "targets": ">0.5%, not dead, not op_mini all, chrome 71",
9
+ "modules": false
10
+ }
11
+ ],
12
+ "@babel/preset-react",
13
+ "@babel/preset-typescript"
14
+ ]
15
+ },
16
+ "cjs": {
17
+ "presets": [
18
+ [
19
+ "@babel/preset-env",
20
+ {
21
+ "targets": { "node": 12 },
22
+ "modules": "commonjs"
23
+ }
24
+ ],
25
+ "@babel/preset-react",
26
+ "@babel/preset-typescript"
27
+ ]
28
+ }
29
+ }
30
+ }
package/.eslintrc CHANGED
@@ -1,17 +1,17 @@
1
- {
2
- "extends": "@chayns-toolkit",
3
- "rules": {
4
- "no-void": "off",
5
- "react/function-component-definition": [
6
- "error",
7
- {
8
- "namedComponents": "arrow-function",
9
- "unnamedComponents": "arrow-function"
10
- }
11
- ],
12
- "@typescript-eslint/require-await": "off",
13
- "@typescript-eslint/no-explicit-any": "off",
14
- "class-methods-use-this": "off",
15
- "react/jsx-props-no-spreading": "off"
16
- }
17
- }
1
+ {
2
+ "extends": "@chayns-toolkit",
3
+ "rules": {
4
+ "no-void": "off",
5
+ "react/function-component-definition": [
6
+ "error",
7
+ {
8
+ "namedComponents": "arrow-function",
9
+ "unnamedComponents": "arrow-function"
10
+ }
11
+ ],
12
+ "@typescript-eslint/require-await": "off",
13
+ "@typescript-eslint/no-explicit-any": "off",
14
+ "class-methods-use-this": "off",
15
+ "react/jsx-props-no-spreading": "off"
16
+ }
17
+ }
@@ -1,28 +1,28 @@
1
- name: Deploy Docs to GitHub Pages
2
-
3
- on:
4
- push:
5
- paths:
6
- - "website/**"
7
- workflow_dispatch:
8
-
9
- jobs:
10
- deploy:
11
- runs-on: ubuntu-20.04
12
- steps:
13
- - name: Checkout repo
14
- uses: actions/checkout@v2
15
-
16
- - name: Use Node 16
17
- uses: actions/setup-node@v1
18
- with:
19
- node-version: 16
20
-
21
- - name: Build
22
- run: npm run build-docs
23
-
24
- - name: Deploy to GitHub Pages
25
- uses: peaceiris/actions-gh-pages@v3
26
- with:
27
- github_token: ${{ secrets.GITHUB_TOKEN }}
28
- publish_dir: ./website/build
1
+ name: Deploy Docs to GitHub Pages
2
+
3
+ on:
4
+ push:
5
+ paths:
6
+ - "website/**"
7
+ workflow_dispatch:
8
+
9
+ jobs:
10
+ deploy:
11
+ runs-on: ubuntu-20.04
12
+ steps:
13
+ - name: Checkout repo
14
+ uses: actions/checkout@v2
15
+
16
+ - name: Use Node 16
17
+ uses: actions/setup-node@v1
18
+ with:
19
+ node-version: 16
20
+
21
+ - name: Build
22
+ run: npm run build-docs
23
+
24
+ - name: Deploy to GitHub Pages
25
+ uses: peaceiris/actions-gh-pages@v3
26
+ with:
27
+ github_token: ${{ secrets.GITHUB_TOKEN }}
28
+ publish_dir: ./website/build
@@ -0,0 +1,21 @@
1
+ name: Publish to NPM
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ push:
6
+ tags:
7
+ - 'v*'
8
+
9
+ jobs:
10
+ build:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/checkout@v2
14
+ - uses: actions/setup-node@v1
15
+ with:
16
+ node-version: '14.21.1'
17
+ registry-url: https://registry.npmjs.org/
18
+ - run: npm install
19
+ - run: npm publish
20
+ env:
21
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2022 Tobit.Software
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Tobit.Software
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,47 +1,47 @@
1
- # [chayns react api](https://github.com/TobitSoftware/chayns-api) · [![license](https://img.shields.io/github/license/TobitSoftware/chayns-api.svg)]() [![GitHub pull requests](https://img.shields.io/github/issues-pr/TobitSoftware/chayns-api.svg)]() [![](https://img.shields.io/github/issues-pr-closed-raw/TobitSoftware/chayns-api.svg)]()
2
-
3
- The chayns-api provides information and useful functions to your page. The information and functions are provided by react hooks and normal functions.
4
- A list of all functions and hooks can be found [here](https://tobitsoftware.github.io/chayns-api/docs).
5
-
6
- ## Installation
7
-
8
- It is recommended to setup your new chayns page with the [create-chayns-app](https://github.com/TobitSoftware/create-chayns-app).
9
-
10
-
11
- ### Migrate old project
12
- 1. Install chayns-api package
13
- ```sh
14
- # NPM
15
- $ npm install chayns-api
16
-
17
- # Yarn
18
- $ yarn add chayns-api
19
- ```
20
-
21
- 2. Wrap your App component with the "ChaynsProvider" component. In all components which are under the ChaynsProvider you can use hooks and chayns functions.
22
- ```jsx
23
- <ChaynsProvider>
24
- <App/>
25
- </ChaynsProvider>
26
- ```
27
-
28
- ## Example
29
-
30
- ```jsx
31
- import { useUser } from 'chayns-api';
32
-
33
- const FirstName = () => {
34
- const user = useUser();
35
-
36
- return (
37
- <div>{user?.firstName}</div>
38
- );
39
- }
40
- ```
41
-
42
- ## Getting started
43
-
44
- More information to setup chayns-api can be found in the [documentation](https://tobitsoftware.github.io/chayns-api/docs).
45
-
46
-
47
- ## License
1
+ # [chayns react api](https://github.com/TobitSoftware/chayns-api) &middot; [![license](https://img.shields.io/github/license/TobitSoftware/chayns-api.svg)]() [![GitHub pull requests](https://img.shields.io/github/issues-pr/TobitSoftware/chayns-api.svg)]() [![](https://img.shields.io/github/issues-pr-closed-raw/TobitSoftware/chayns-api.svg)]()
2
+
3
+ The chayns-api provides information and useful functions to your page. The information and functions are provided by react hooks and normal functions.
4
+ A list of all functions and hooks can be found [here](https://tobitsoftware.github.io/chayns-api/docs).
5
+
6
+ ## Installation
7
+
8
+ It is recommended to setup your new chayns page with the [create-chayns-app](https://github.com/TobitSoftware/create-chayns-app).
9
+
10
+
11
+ ### Migrate old project
12
+ 1. Install chayns-api package
13
+ ```sh
14
+ # NPM
15
+ $ npm install chayns-api
16
+
17
+ # Yarn
18
+ $ yarn add chayns-api
19
+ ```
20
+
21
+ 2. Wrap your App component with the "ChaynsProvider" component. In all components which are under the ChaynsProvider you can use hooks and chayns functions.
22
+ ```jsx
23
+ <ChaynsProvider>
24
+ <App/>
25
+ </ChaynsProvider>
26
+ ```
27
+
28
+ ## Example
29
+
30
+ ```jsx
31
+ import { useUser } from 'chayns-api';
32
+
33
+ const FirstName = () => {
34
+ const user = useUser();
35
+
36
+ return (
37
+ <div>{user?.firstName}</div>
38
+ );
39
+ }
40
+ ```
41
+
42
+ ## Getting started
43
+
44
+ More information to setup chayns-api can be found in the [documentation](https://tobitsoftware.github.io/chayns-api/docs).
45
+
46
+
47
+ ## License
@@ -142,18 +142,18 @@ function advancedDate(config = {}) {
142
142
  });
143
143
  }
144
144
 
145
- /**
146
- * @typedef {number} dateDialogType
145
+ /**
146
+ * @typedef {number} dateDialogType
147
147
  */
148
148
 
149
- /**
150
- * Enum for date dialog
151
- * <div>DATE will open a dialog where you can select a special day</div>
152
- * <div>TIME will open a dialog where you can only select a special time</div>
153
- * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
154
- * @readonly
155
- * @enum {dateDialogType}
156
- * @type {{DATE: number, TIME: number, DATE_TIME: number}}
149
+ /**
150
+ * Enum for date dialog
151
+ * <div>DATE will open a dialog where you can select a special day</div>
152
+ * <div>TIME will open a dialog where you can only select a special time</div>
153
+ * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
154
+ * @readonly
155
+ * @enum {dateDialogType}
156
+ * @type {{DATE: number, TIME: number, DATE_TIME: number}}
157
157
  */
158
158
  const dateType = {
159
159
  'DATE': 1,
@@ -5,61 +5,61 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  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;
7
7
  var _ChaynsProvider = require("../components/ChaynsProvider");
8
- /**
9
- * This adds a listener to determine your location.
10
- * @category Event listener
8
+ /**
9
+ * This adds a listener to determine your location.
10
+ * @category Event listener
11
11
  */
12
12
  const addGeoLocationListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addGeoLocationListener(...args);
13
- /**
14
- * Adds a listener for scroll event by user.
15
- * @category Event listener
13
+ /**
14
+ * Adds a listener for scroll event by user.
15
+ * @category Event listener
16
16
  */
17
17
  exports.addGeoLocationListener = addGeoLocationListener;
18
18
  const addScrollListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addScrollListener(...args);
19
- /**
20
- * This method will be executed when the page gets displayed or hidden.
21
- * @category Event listener
19
+ /**
20
+ * This method will be executed when the page gets displayed or hidden.
21
+ * @category Event listener
22
22
  */
23
23
  exports.addScrollListener = addScrollListener;
24
24
  const addVisibilityChangeListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addVisibilityChangeListener(...args);
25
- /**
26
- * This adds a listener to get the actual height of the page.
27
- * @category Event listener
25
+ /**
26
+ * This adds a listener to get the actual height of the page.
27
+ * @category Event listener
28
28
  */
29
29
  exports.addVisibilityChangeListener = addVisibilityChangeListener;
30
- const addWindowMetricsListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addWindowMetricsListener(...args); /**
31
- * Allows a custom callback function to be defined
30
+ const addWindowMetricsListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.addWindowMetricsListener(...args); /**
31
+ * Allows a custom callback function to be defined
32
32
  */
33
33
  exports.addWindowMetricsListener = addWindowMetricsListener;
34
34
  const customCallbackFunction = (...args) => _ChaynsProvider.moduleWrapper.current.functions.customCallbackFunction(...args);
35
- /**
36
- * Get the accessToken from the user.
35
+ /**
36
+ * Get the accessToken from the user.
37
37
  */
38
38
  exports.customCallbackFunction = customCallbackFunction;
39
39
  const getAccessToken = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getAccessToken(...args);
40
- /**
41
- * This method returns a list of installed share/social media apps.
40
+ /**
41
+ * This method returns a list of installed share/social media apps.
42
42
  */
43
43
  exports.getAccessToken = getAccessToken;
44
44
  const getAvailableSharingServices = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getAvailableSharingServices(...args);
45
- /**
46
- * This method determines your location. If you want to track a route, use addGeoLocationListener.
45
+ /**
46
+ * This method determines your location. If you want to track a route, use addGeoLocationListener.
47
47
  */
48
48
  exports.getAvailableSharingServices = getAvailableSharingServices;
49
49
  const getGeoLocation = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getGeoLocation(...args);
50
- /**
51
- * This method returns user information for a specific user.
52
- * @category User functions
50
+ /**
51
+ * This method returns user information for a specific user.
52
+ * @category User functions
53
53
  */
54
54
  exports.getGeoLocation = getGeoLocation;
55
55
  const getUserInfo = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getUserInfo(...args);
56
- /**
57
- * Return the current scroll position of the top frame
56
+ /**
57
+ * Return the current scroll position of the top frame
58
58
  */
59
59
  exports.getUserInfo = getUserInfo;
60
60
  const getScrollPosition = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getScrollPosition(...args);
61
- /**
62
- * Returns the window metrics.
61
+ /**
62
+ * Returns the window metrics.
63
63
  */
64
64
  exports.getScrollPosition = getScrollPosition;
65
65
  const getWindowMetrics = (...args) => _ChaynsProvider.moduleWrapper.current.functions.getWindowMetrics(...args);
@@ -69,163 +69,163 @@ const invokeCall = (...args) => _ChaynsProvider.moduleWrapper.current.functions.
69
69
  /** @internal */
70
70
  exports.invokeCall = invokeCall;
71
71
  const invokeDialogCall = (...args) => _ChaynsProvider.moduleWrapper.current.functions.invokeDialogCall(...args);
72
- /**
73
- * This method will show a login dialog where the user has the opportunity to log in.
72
+ /**
73
+ * This method will show a login dialog where the user has the opportunity to log in.
74
74
  */
75
75
  exports.invokeDialogCall = invokeDialogCall;
76
76
  const login = (...args) => _ChaynsProvider.moduleWrapper.current.functions.login(...args);
77
- /**
78
- * This method will logout the user
77
+ /**
78
+ * This method will logout the user
79
79
  */
80
80
  exports.login = login;
81
81
  const logout = (...args) => _ChaynsProvider.moduleWrapper.current.functions.logout(...args);
82
- /**
83
- * This function navigates you to the previous site.
82
+ /**
83
+ * This function navigates you to the previous site.
84
84
  */
85
85
  exports.logout = logout;
86
86
  const navigateBack = (...args) => _ChaynsProvider.moduleWrapper.current.functions.navigateBack(...args);
87
- /**
88
- * The images specified in the url array is shown in gallery mode.
87
+ /**
88
+ * The images specified in the url array is shown in gallery mode.
89
89
  */
90
90
  exports.navigateBack = navigateBack;
91
91
  const openImage = (...args) => _ChaynsProvider.moduleWrapper.current.functions.openImage(...args);
92
- /**
93
- * Opens an URL in the chayns environment.
92
+ /**
93
+ * Opens an URL in the chayns environment.
94
94
  */
95
95
  exports.openImage = openImage;
96
96
  const openUrl = (...args) => _ChaynsProvider.moduleWrapper.current.functions.openUrl(...args);
97
- /**
98
- * The video specified in the URL is shown in video mode.
97
+ /**
98
+ * The video specified in the URL is shown in video mode.
99
99
  */
100
100
  exports.openUrl = openUrl;
101
101
  const openVideo = (...args) => _ChaynsProvider.moduleWrapper.current.functions.openVideo(...args);
102
- /**
103
- * Refresh badge count in navigation, user information and pages
102
+ /**
103
+ * Refresh badge count in navigation, user information and pages
104
104
  */
105
105
  exports.openVideo = openVideo;
106
106
  const refreshData = (...args) => _ChaynsProvider.moduleWrapper.current.functions.refreshData(...args);
107
- /**
108
- * Refresh accesstoken, should only be used when user object changes, not when token is invalid
107
+ /**
108
+ * Refresh accesstoken, should only be used when user object changes, not when token is invalid
109
109
  */
110
110
  exports.refreshData = refreshData;
111
111
  const refreshAccessToken = (...args) => _ChaynsProvider.moduleWrapper.current.functions.refreshAccessToken(...args);
112
- /**
113
- * This removes a listener to determine your location.
114
- * @category Event listener
112
+ /**
113
+ * This removes a listener to determine your location.
114
+ * @category Event listener
115
115
  */
116
116
  exports.refreshAccessToken = refreshAccessToken;
117
117
  const removeGeoLocationListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeGeoLocationListener(...args);
118
- /**
119
- * Removes scroll listener.
120
- * @category Event listener
118
+ /**
119
+ * Removes scroll listener.
120
+ * @category Event listener
121
121
  */
122
122
  exports.removeGeoLocationListener = removeGeoLocationListener;
123
123
  const removeScrollListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeScrollListener(...args);
124
- /**
125
- * Removes visibility change listener.
126
- * @category Event listener
124
+ /**
125
+ * Removes visibility change listener.
126
+ * @category Event listener
127
127
  */
128
128
  exports.removeScrollListener = removeScrollListener;
129
129
  const removeVisibilityChangeListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeVisibilityChangeListener(...args);
130
- /**
131
- * Removes window metrics listener.
132
- * @category Event listener
130
+ /**
131
+ * Removes window metrics listener.
132
+ * @category Event listener
133
133
  */
134
134
  exports.removeVisibilityChangeListener = removeVisibilityChangeListener;
135
135
  const removeWindowMetricsListener = (...args) => _ChaynsProvider.moduleWrapper.current.functions.removeWindowMetricsListener(...args);
136
- /**
137
- * Select other page on chayns site.
136
+ /**
137
+ * Select other page on chayns site.
138
138
  */
139
139
  exports.removeWindowMetricsListener = removeWindowMetricsListener;
140
140
  const selectPage = (...args) => _ChaynsProvider.moduleWrapper.current.functions.selectPage(...args);
141
- /**
142
- * Scrolls to specific position.
141
+ /**
142
+ * Scrolls to specific position.
143
143
  */
144
144
  exports.selectPage = selectPage;
145
145
  const scrollToY = (...args) => _ChaynsProvider.moduleWrapper.current.functions.scrollToY(...args);
146
- /**
147
- * Sends intercom message to group.
146
+ /**
147
+ * Sends intercom message to group.
148
148
  */
149
149
  exports.scrollToY = scrollToY;
150
150
  const sendMessageToGroup = (...args) => _ChaynsProvider.moduleWrapper.current.functions.sendMessageToGroup(...args);
151
- /**
152
- * Sends intercom message to page.
151
+ /**
152
+ * Sends intercom message to page.
153
153
  */
154
154
  exports.sendMessageToGroup = sendMessageToGroup;
155
155
  const sendMessageToPage = (...args) => _ChaynsProvider.moduleWrapper.current.functions.sendMessageToPage(...args);
156
- /**
157
- * Sends intercom message to an user.
156
+ /**
157
+ * Sends intercom message to an user.
158
158
  */
159
159
  exports.sendMessageToPage = sendMessageToPage;
160
160
  const sendMessageToUser = (...args) => _ChaynsProvider.moduleWrapper.current.functions.sendMessageToUser(...args);
161
- /**
162
- * Switches admin mode, also toggles admin switch in top frame.
161
+ /**
162
+ * Switches admin mode, also toggles admin switch in top frame.
163
163
  */
164
164
  exports.sendMessageToUser = sendMessageToUser;
165
165
  const setAdminMode = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setAdminMode(...args);
166
- /**
167
- * Sets the display timeout, only works in chayns App.
166
+ /**
167
+ * Sets the display timeout, only works in chayns App.
168
168
  */
169
169
  exports.setAdminMode = setAdminMode;
170
170
  const setDisplayTimeout = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setDisplayTimeout(...args);
171
- /**
172
- * Enables or disables a button which floats over the page.
171
+ /**
172
+ * Enables or disables a button which floats over the page.
173
173
  */
174
174
  exports.setDisplayTimeout = setDisplayTimeout;
175
175
  const setFloatingButton = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setFloatingButton(...args);
176
- /**
177
- * Sets the height of the page.
176
+ /**
177
+ * Sets the height of the page.
178
178
  */
179
179
  exports.setFloatingButton = setFloatingButton;
180
180
  const setHeight = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setHeight(...args);
181
- /**
182
- * Enables or disables the ability to refresh a page
181
+ /**
182
+ * Enables or disables the ability to refresh a page
183
183
  */
184
184
  exports.setHeight = setHeight;
185
185
  const setRefreshScrollEnabled = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setRefreshScrollEnabled(...args);
186
- /**
187
- * Scans a qr-code and returns the result
186
+ /**
187
+ * Scans a qr-code and returns the result
188
188
  */
189
189
  exports.setRefreshScrollEnabled = setRefreshScrollEnabled;
190
190
  const setScanQrCode = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setScanQrCode(...args);
191
- /**
192
- * Temporarily change design settings in top frame
191
+ /**
192
+ * Temporarily change design settings in top frame
193
193
  */
194
194
  exports.setScanQrCode = setScanQrCode;
195
195
  const setTempDesignSettings = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setTempDesignSettings(...args);
196
- /**
197
- * Shows or hide a waitcursor
196
+ /**
197
+ * Shows or hide a waitcursor
198
198
  */
199
199
  exports.setTempDesignSettings = setTempDesignSettings;
200
200
  const setWaitCursor = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setWaitCursor(...args);
201
- /**
202
- * Retrieves the value that is assigned to the key from a storage outside the frame
201
+ /**
202
+ * Retrieves the value that is assigned to the key from a storage outside the frame
203
203
  */
204
204
  exports.setWaitCursor = setWaitCursor;
205
205
  const storageGetItem = (...args) => _ChaynsProvider.moduleWrapper.current.functions.storageGetItem(...args);
206
- /**
207
- * Removes the value that is assigned to the key from a storage outside the frame
206
+ /**
207
+ * Removes the value that is assigned to the key from a storage outside the frame
208
208
  */
209
209
  exports.storageGetItem = storageGetItem;
210
210
  const storageRemoveItem = (...args) => _ChaynsProvider.moduleWrapper.current.functions.storageRemoveItem(...args);
211
- /**
212
- * Sets the value that is assigned to the key from a storage outside the frame
211
+ /**
212
+ * Sets the value that is assigned to the key from a storage outside the frame
213
213
  */
214
214
  exports.storageRemoveItem = storageRemoveItem;
215
215
  const storageSetItem = (...args) => _ChaynsProvider.moduleWrapper.current.functions.storageSetItem(...args);
216
- /**
217
- * This method lets a smartphone vibrate for the given time.
216
+ /**
217
+ * This method lets a smartphone vibrate for the given time.
218
218
  */
219
219
  exports.storageSetItem = storageSetItem;
220
220
  const vibrate = (...args) => _ChaynsProvider.moduleWrapper.current.functions.vibrate(...args);
221
- /**
222
- * Displays an overlay
221
+ /**
222
+ * Displays an overlay
223
223
  */
224
224
  exports.vibrate = vibrate;
225
225
  const setOverlay = (...args) => _ChaynsProvider.moduleWrapper.current.functions.setOverlay(...args);
226
- /**
227
- * Returns user information, only when user is logged in
228
- * @category User functions
226
+ /**
227
+ * Returns user information, only when user is logged in
228
+ * @category User functions
229
229
  */
230
230
  exports.setOverlay = setOverlay;
231
231
  const getUser = () => _ChaynsProvider.moduleWrapper.current.values.user;