chayns-api 1.0.13 → 1.1.0-2

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 (139) 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 -21
  5. package/LICENSE +21 -21
  6. package/README.md +54 -54
  7. package/dist/cjs/calls/dialogs/date.js +10 -10
  8. package/dist/cjs/calls/index.js +102 -97
  9. package/dist/cjs/calls/sendMessage.js +8 -8
  10. package/dist/cjs/calls/visibilityChangeListener.js +4 -4
  11. package/dist/cjs/components/AppDialogWrapper.js +42 -0
  12. package/dist/cjs/components/ChaynsProvider.js +5 -2
  13. package/dist/cjs/handler/DialogHandler.js +63 -0
  14. package/dist/cjs/hooks/geoLocationListener.js +4 -4
  15. package/dist/cjs/hooks/index.js +14 -1
  16. package/dist/cjs/hooks/scrollListener.js +8 -8
  17. package/dist/cjs/hooks/useAccessToken.js +2 -2
  18. package/dist/cjs/hooks/useCurrentPage.js +2 -2
  19. package/dist/cjs/hooks/useCustomData.js +2 -2
  20. package/dist/cjs/hooks/useDevice.js +2 -2
  21. package/dist/cjs/hooks/useDialogState.js +39 -0
  22. package/dist/cjs/hooks/useEnvironment.js +2 -2
  23. package/dist/cjs/hooks/useFunctions.js +2 -2
  24. package/dist/cjs/hooks/useIsAdminMode.js +2 -2
  25. package/dist/cjs/hooks/useLanguage.js +2 -2
  26. package/dist/cjs/hooks/usePages.js +4 -4
  27. package/dist/cjs/hooks/useParameters.js +2 -2
  28. package/dist/cjs/hooks/useSite.js +2 -2
  29. package/dist/cjs/hooks/useUser.js +2 -2
  30. package/dist/cjs/hooks/useValues.js +2 -2
  31. package/dist/cjs/hooks/windowMetricsListener.js +4 -4
  32. package/dist/cjs/host/ChaynsHost.js +10 -5
  33. package/dist/cjs/host/iframe/HostIframe.js +5 -2
  34. package/dist/cjs/host/module/ModuleHost.js +4 -0
  35. package/dist/cjs/types/IChaynsReact.js +22 -2
  36. package/dist/cjs/util/deviceHelper.js +7 -6
  37. package/dist/cjs/wrapper/AppWrapper.js +42 -6
  38. package/dist/cjs/wrapper/FrameWrapper.js +52 -1
  39. package/dist/cjs/wrapper/ModuleFederationWrapper.js +4 -0
  40. package/dist/esm/calls/dialogs/date.js +34 -34
  41. package/dist/esm/calls/index.js +102 -96
  42. package/dist/esm/calls/sendMessage.js +8 -8
  43. package/dist/esm/calls/visibilityChangeListener.js +4 -4
  44. package/dist/esm/components/AppDialogWrapper.js +33 -0
  45. package/dist/esm/components/ChaynsProvider.js +5 -2
  46. package/dist/esm/handler/DialogHandler.js +59 -0
  47. package/dist/esm/hooks/geoLocationListener.js +4 -4
  48. package/dist/esm/hooks/index.js +2 -1
  49. package/dist/esm/hooks/scrollListener.js +8 -8
  50. package/dist/esm/hooks/useAccessToken.js +2 -2
  51. package/dist/esm/hooks/useCurrentPage.js +2 -2
  52. package/dist/esm/hooks/useCustomData.js +2 -2
  53. package/dist/esm/hooks/useDevice.js +2 -2
  54. package/dist/esm/hooks/useDialogState.js +32 -0
  55. package/dist/esm/hooks/useEnvironment.js +2 -2
  56. package/dist/esm/hooks/useFunctions.js +2 -2
  57. package/dist/esm/hooks/useIsAdminMode.js +2 -2
  58. package/dist/esm/hooks/useLanguage.js +2 -2
  59. package/dist/esm/hooks/usePages.js +4 -4
  60. package/dist/esm/hooks/useParameters.js +2 -2
  61. package/dist/esm/hooks/useSite.js +2 -2
  62. package/dist/esm/hooks/useUser.js +2 -2
  63. package/dist/esm/hooks/useValues.js +2 -2
  64. package/dist/esm/hooks/windowMetricsListener.js +4 -4
  65. package/dist/esm/host/ChaynsHost.js +10 -5
  66. package/dist/esm/host/iframe/HostIframe.js +5 -2
  67. package/dist/esm/host/module/ModuleHost.js +4 -0
  68. package/dist/esm/types/IChaynsReact.js +19 -1
  69. package/dist/esm/util/deviceHelper.js +7 -6
  70. package/dist/esm/wrapper/AppWrapper.js +42 -6
  71. package/dist/esm/wrapper/FrameWrapper.js +52 -1
  72. package/dist/esm/wrapper/ModuleFederationWrapper.js +4 -0
  73. package/dist/types/calls/dialogs/alert.d.ts +1 -1
  74. package/dist/types/calls/dialogs/chaynsDialog.d.ts +24 -24
  75. package/dist/types/calls/dialogs/close.d.ts +1 -1
  76. package/dist/types/calls/dialogs/communication.d.ts +3 -3
  77. package/dist/types/calls/dialogs/confirm.d.ts +13 -13
  78. package/dist/types/calls/dialogs/date.d.ts +96 -96
  79. package/dist/types/calls/dialogs/dropUpAlert.d.ts +5 -5
  80. package/dist/types/calls/dialogs/fileSelect.d.ts +16 -16
  81. package/dist/types/calls/dialogs/iFrame.d.ts +10 -10
  82. package/dist/types/calls/dialogs/index.d.ts +14 -14
  83. package/dist/types/calls/dialogs/input.d.ts +15 -15
  84. package/dist/types/calls/dialogs/mediaSelect.d.ts +8 -8
  85. package/dist/types/calls/dialogs/open.d.ts +1 -1
  86. package/dist/types/calls/dialogs/select.d.ts +6 -6
  87. package/dist/types/calls/dialogs/signature.d.ts +7 -7
  88. package/dist/types/calls/dialogs/toast.d.ts +1 -1
  89. package/dist/types/calls/dialogs/utils/callback.d.ts +1 -1
  90. package/dist/types/calls/dialogs/utils/is.d.ts +4 -4
  91. package/dist/types/calls/getUserInfo.d.ts +9 -9
  92. package/dist/types/calls/index.d.ts +237 -233
  93. package/dist/types/calls/sendMessage.d.ts +13 -13
  94. package/dist/types/calls/visibilityChangeListener.d.ts +9 -9
  95. package/dist/types/components/AppDialogWrapper.d.ts +5 -0
  96. package/dist/types/components/ChaynsContext.d.ts +3 -3
  97. package/dist/types/components/ChaynsProvider.d.ts +14 -14
  98. package/dist/types/components/WaitUntil.d.ts +7 -8
  99. package/dist/types/components/withCompatMode.d.ts +13 -13
  100. package/dist/types/handler/DialogHandler.d.ts +19 -0
  101. package/dist/types/helper/apiListenerHelper.d.ts +6 -6
  102. package/dist/types/hooks/geoLocationListener.d.ts +18 -18
  103. package/dist/types/hooks/index.d.ts +17 -16
  104. package/dist/types/hooks/scrollListener.d.ts +28 -28
  105. package/dist/types/hooks/useAccessToken.d.ts +5 -5
  106. package/dist/types/hooks/useCurrentPage.d.ts +4 -4
  107. package/dist/types/hooks/useCustomData.d.ts +4 -4
  108. package/dist/types/hooks/useDevice.d.ts +5 -5
  109. package/dist/types/hooks/useDialogState.d.ts +9 -0
  110. package/dist/types/hooks/useEnvironment.d.ts +5 -5
  111. package/dist/types/hooks/useFunctions.d.ts +5 -5
  112. package/dist/types/hooks/useIsAdminMode.d.ts +4 -4
  113. package/dist/types/hooks/useLanguage.d.ts +5 -5
  114. package/dist/types/hooks/usePages.d.ts +18 -18
  115. package/dist/types/hooks/useParameters.d.ts +5 -5
  116. package/dist/types/hooks/useSite.d.ts +5 -5
  117. package/dist/types/hooks/useUser.d.ts +5 -5
  118. package/dist/types/hooks/useValues.d.ts +5 -5
  119. package/dist/types/hooks/windowMetricsListener.d.ts +11 -11
  120. package/dist/types/host/ChaynsHost.d.ts +30 -29
  121. package/dist/types/host/iframe/HostIframe.d.ts +26 -25
  122. package/dist/types/host/iframe/utils/useUpdateData.d.ts +3 -3
  123. package/dist/types/host/module/ModuleHost.d.ts +26 -25
  124. package/dist/types/host/module/utils/loadComponent.d.ts +1 -1
  125. package/dist/types/host/module/utils/useDynamicScript.d.ts +9 -9
  126. package/dist/types/index.d.ts +16 -16
  127. package/dist/types/types/IChaynsReact.d.ts +708 -624
  128. package/dist/types/types/dialog.d.ts +41 -41
  129. package/dist/types/util/appCall.d.ts +2 -2
  130. package/dist/types/util/deviceHelper.d.ts +7 -7
  131. package/dist/types/util/heightHelper.d.ts +1 -1
  132. package/dist/types/util/postIframeForm.d.ts +1 -1
  133. package/dist/types/util/url.d.ts +1 -1
  134. package/dist/types/wrapper/AppWrapper.d.ts +22 -18
  135. package/dist/types/wrapper/FrameWrapper.d.ts +15 -15
  136. package/dist/types/wrapper/ModuleFederationWrapper.d.ts +10 -10
  137. package/dist/types/wrapper/SsrWrapper.d.ts +11 -11
  138. package/package.json +75 -75
  139. package/tsconfig.json +56 -56
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
@@ -1,21 +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 }}
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,54 +1,54 @@
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
- ## Troubleshooting
47
-
48
- ```
49
- Can't resolve 'react-dom/client'
50
- ```
51
- A warning like above can be shown when you are still using react 17.
52
- This can be ignored because the react 17 api is used as fallback instead.
53
-
54
- ## 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
+ ## Troubleshooting
47
+
48
+ ```
49
+ Can't resolve 'react-dom/client'
50
+ ```
51
+ A warning like above can be shown when you are still using react 17.
52
+ This can be ignored because the react 17 api is used as fallback instead.
53
+
54
+ ## 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,