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
@@ -1,170 +0,0 @@
1
- import { ReactChild, ReactChildren } from "react";
2
- import { ChaynsApiDevice, ChaynsApiSite, ChaynsReactValues, UserInfo } from "../types/IChaynsReact";
3
- interface TestChild {
4
- children: ReactChild | ReactChildren;
5
- }
6
- declare const ChaynsProvider: ({ children, renderedByServer, ...props }: TestChild) => false | JSX.Element;
7
- export declare const useGeoLocation: (args_0?: {
8
- enabled?: boolean | undefined;
9
- timeout?: number | undefined;
10
- silent?: boolean | undefined;
11
- } | undefined) => {
12
- value: import("../types/IChaynsReact").GeoLocation | null;
13
- };
14
- export declare const addGeoLocationListener: (value: {
15
- timeout?: number | undefined;
16
- silent?: boolean | undefined;
17
- }, callback: (geoLocation: import("../types/IChaynsReact").GeoLocation) => void) => Promise<number>;
18
- export declare const addScrollListener: (value: {
19
- throttle?: number | undefined;
20
- }, callback: (result: import("../types/IChaynsReact").ScrollListenerResult) => void) => Promise<number>;
21
- export declare const addVisibilityChangeListener: (callback: (result: import("../types/IChaynsReact").VisibilityChangeListenerResult) => void) => Promise<number>;
22
- export declare const addWindowMetricsListener: (callback: (result: import("../types/IChaynsReact").WindowMetricsListenerResult) => void) => Promise<number>;
23
- export declare const getAccessToken: (value?: import("../types/IChaynsReact").AccessToken | undefined) => Promise<import("../types/IChaynsReact").AccessTokenResult>;
24
- export declare const getAvailableSharingServices: () => Promise<import("../types/IChaynsReact").AvailableSharingServices>;
25
- export declare const getGeoLocation: (value: {
26
- timeout?: number | undefined;
27
- silent?: boolean | undefined;
28
- }) => Promise<import("../types/IChaynsReact").GeoLocation>;
29
- export declare const getUserInfo: (value: import("../types/IChaynsReact").UserInfoQuery) => Promise<UserInfo | null>;
30
- export declare const getScrollPosition: () => Promise<import("../types/IChaynsReact").ScrollListenerResult>;
31
- export declare const getWindowMetrics: () => Promise<import("../types/IChaynsReact").WindowMetricsListenerResult>;
32
- export declare const invokeCall: (value: import("../types/IChaynsReact").InvokeCall, callback?: ((result: any) => void) | undefined) => Promise<any>;
33
- export declare const invokeDialogCall: (value: import("../types/IChaynsReact").InvokeCall, callback?: ((result: any) => void) | undefined) => Promise<any>;
34
- export declare const login: (value?: import("../types/IChaynsReact").Login | undefined, callback?: ((result: boolean) => void) | undefined, closeCallback?: (() => void) | undefined) => Promise<import("../types/IChaynsReact").LoginResult>;
35
- export declare const logout: () => Promise<void>;
36
- export declare const navigateBack: () => Promise<void>;
37
- export declare const openImage: (value: import("../types/IChaynsReact").OpenImage) => Promise<void>;
38
- export declare const openUrl: (value: import("../types/IChaynsReact").OpenUrl) => Promise<void>;
39
- export declare const openVideo: (value: import("../types/IChaynsReact").OpenVideo) => Promise<void>;
40
- export declare const refreshAccessToken: () => Promise<void>;
41
- export declare const refreshData: (value: import("../types/IChaynsReact").RefreshData) => Promise<void>;
42
- export declare const removeGeoLocationListener: (value: number) => Promise<void>;
43
- export declare const removeScrollListener: (value: number) => Promise<void>;
44
- export declare const removeVisibilityChangeListener: (value: number) => Promise<void>;
45
- export declare const removeWindowMetricsListener: (value: number) => Promise<void>;
46
- export declare const selectPage: (value: import("../types/IChaynsReact").SelectPage) => Promise<void>;
47
- export declare const scrollToY: (position: number, duration: number) => Promise<void>;
48
- export declare const sendMessageToGroup: (groupId: number, message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
49
- export declare const sendMessageToPage: (message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
50
- export declare const sendMessageToUser: (userId: number, message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
51
- export declare const setAdminMode: (enabled: boolean) => Promise<void>;
52
- export declare const setDisplayTimeout: (enabled: boolean) => Promise<import("../types/IChaynsReact").DisplayTimeout>;
53
- export declare const setFloatingButton: (value: import("../types/IChaynsReact").FloatingButton, callback: () => void) => Promise<void>;
54
- export declare const setHeight: (height: number) => Promise<void>;
55
- export declare const setOverlay: (value: import("../types/IChaynsReact").ShowOverlay, callback: () => void) => Promise<void>;
56
- export declare const setRefreshScrollEnabled: (enabled: boolean) => Promise<import("../types/IChaynsReact").RefreshScrollEnabled>;
57
- export declare const setScanQrCode: (value: import("../types/IChaynsReact").ScanQrCodeRequest) => Promise<import("../types/IChaynsReact").ScanQrCodeResult>;
58
- export declare const setTempDesignSettings: (value: import("../types/IChaynsReact").DesignSettings) => Promise<void>;
59
- export declare const setWaitCursor: (value: import("../types/IChaynsReact").WaitCursor) => Promise<void>;
60
- export declare const storageGetItem: (key: string, accessMode: import("../types/IChaynsReact").AccessMode) => Promise<any>;
61
- export declare const storageRemoveItem: (key: string, accessMode: import("../types/IChaynsReact").AccessMode) => Promise<void>;
62
- export declare const storageSetItem: (key: string, value: any, accessMode: import("../types/IChaynsReact").AccessMode, tappIds: number[]) => Promise<void>;
63
- export declare const vibrate: (value: import("../types/IChaynsReact").Vibrate) => Promise<void>;
64
- export declare const useAccessToken: (accessToken?: import("../types/IChaynsReact").AccessToken | undefined) => string | undefined;
65
- export declare const useWindowMetrics: (args_0?: {
66
- enabled?: boolean | undefined;
67
- } | undefined) => import("../types/IChaynsReact").WindowMetricsListenerResult;
68
- export declare const useScrollPosition: (args_0?: {
69
- enabled?: boolean | undefined;
70
- throttle?: number | undefined;
71
- } | undefined) => import("../types/IChaynsReact").ScrollListenerResult;
72
- export declare const useUser: () => import("../types/IChaynsReact").ChaynsApiUser;
73
- export declare const useIsAdminMode: () => boolean;
74
- export declare const useScrollOffsetTop: (args_0?: {
75
- enabled?: boolean | undefined;
76
- throttle?: number | undefined;
77
- } | undefined) => number;
78
- export declare const useScrollOffsetBottom: (args_0?: {
79
- enabled?: boolean | undefined;
80
- throttle?: number | undefined;
81
- } | undefined) => number;
82
- export declare const useScrollListener: () => (value: {
83
- throttle?: number | undefined;
84
- }, callback: (result: import("../types/IChaynsReact").ScrollListenerResult) => void) => () => void;
85
- export declare const useWindowMetricsListener: () => (callback: (result: import("../types/IChaynsReact").WindowMetricsListenerResult) => void) => () => void;
86
- export declare const useGeoLocationListener: () => (value: {
87
- timeout?: number | undefined;
88
- silent?: boolean | undefined;
89
- }, callback: (result: import("../types/IChaynsReact").GeoLocation) => void) => () => void;
90
- export declare const WaitUntil: ({ children, ...props }: TestChild) => JSX.Element;
91
- export declare const getUser: () => import("../types/IChaynsReact").ChaynsApiUser | undefined;
92
- export declare const getSite: () => ChaynsApiSite;
93
- export declare const getDevice: () => ChaynsApiDevice;
94
- export declare const useDevice: () => ChaynsApiDevice;
95
- export declare const useSite: () => ChaynsApiSite;
96
- export declare const getLanguage: () => {
97
- site: import("../types/IChaynsReact").Language;
98
- translation: import("../types/IChaynsReact").Language;
99
- device: import("../types/IChaynsReact").Language;
100
- active: import("../types/IChaynsReact").Language;
101
- };
102
- export declare const getParameters: () => {
103
- [key: string]: string;
104
- [key: symbol]: string;
105
- };
106
- export declare const useParameters: () => {
107
- [key: string]: string;
108
- [key: symbol]: string;
109
- };
110
- export declare const usePages: () => import("../types/IChaynsReact").Page[];
111
- export declare const usePage: () => import("../types/IChaynsReact").Page | null;
112
- export declare const getPages: () => import("../types/IChaynsReact").Page[];
113
- export declare const useEnvironment: () => {
114
- buildEnvironment: import("../types/IChaynsReact").Environment;
115
- runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
116
- };
117
- export declare const useCustomData: () => any;
118
- export declare const getEnvironment: () => {
119
- buildEnvironment: import("../types/IChaynsReact").Environment;
120
- runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
121
- };
122
- export declare const useLanguage: () => {
123
- site: import("../types/IChaynsReact").Language;
124
- translation: import("../types/IChaynsReact").Language;
125
- device: import("../types/IChaynsReact").Language;
126
- active: import("../types/IChaynsReact").Language;
127
- };
128
- export declare const useValues: () => ChaynsReactValues;
129
- export declare const useFunctions: () => import("../types/IChaynsReact").ChaynsReactFunctions;
130
- export declare const useCurrentPage: () => any;
131
- /**
132
- * @deprecated
133
- */
134
- export declare const user: UserInfo;
135
- /**
136
- * @deprecated
137
- */
138
- export declare const site: ChaynsApiSite;
139
- /**
140
- * @deprecated
141
- */
142
- export declare const device: ChaynsApiDevice;
143
- /**
144
- * @deprecated
145
- */
146
- export declare const language: {
147
- site: import("../types/IChaynsReact").Language;
148
- translation: import("../types/IChaynsReact").Language;
149
- device: import("../types/IChaynsReact").Language;
150
- active: import("../types/IChaynsReact").Language;
151
- };
152
- /**
153
- * @deprecated
154
- */
155
- export declare const parameters: {
156
- [key: string]: string;
157
- [key: symbol]: string;
158
- };
159
- /**
160
- * @deprecated
161
- */
162
- export declare const pages: import("../types/IChaynsReact").Page[];
163
- /**
164
- * @deprecated
165
- */
166
- export declare const environment: {
167
- buildEnvironment: import("../types/IChaynsReact").Environment;
168
- runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
169
- };
170
- export default ChaynsProvider;
@@ -1,22 +0,0 @@
1
- import React, { FC } from 'react';
2
- import { ChaynsApiDevice, ChaynsApiSite, ChaynsApiUser, ChaynsReactFunctions, ChaynsReactValues, Page } from '../../types/IChaynsReact';
3
- declare type PagemakerFrameProps = {
4
- iFrameProps: {
5
- [key: string]: unknown;
6
- name: string;
7
- };
8
- postForm?: boolean;
9
- iFrameRef: React.MutableRefObject<HTMLIFrameElement | null> | undefined;
10
- pages: Page[];
11
- isAdminModeActive: boolean;
12
- site: ChaynsApiSite;
13
- user: ChaynsApiUser;
14
- currentPage: ChaynsReactValues["currentPage"];
15
- functions: ChaynsReactFunctions;
16
- device: ChaynsApiDevice;
17
- language: ChaynsReactValues["language"];
18
- parameters: ChaynsReactValues["parameters"];
19
- environment: ChaynsReactValues["environment"];
20
- };
21
- declare const PagemakerFrame: FC<PagemakerFrameProps>;
22
- export default PagemakerFrame;