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
@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.sendMessageToUser = exports.sendMessageToPage = exports.sendMessageToGroup = void 0;
7
7
  const INTERCOM_URL = 'https://sub54.tobit.com/rest/api';
8
- /**
9
- * @category Intercom functions
8
+ /**
9
+ * @category Intercom functions
10
10
  */
11
11
  const sendMessageToUser = async (api, object, receiverUserId) => {
12
12
  var _api$values$user;
@@ -40,8 +40,8 @@ const sendMessageToUser = async (api, object, receiverUserId) => {
40
40
  }
41
41
  });
42
42
  };
43
- /**
44
- * @category Intercom functions
43
+ /**
44
+ * @category Intercom functions
45
45
  */
46
46
  exports.sendMessageToUser = sendMessageToUser;
47
47
  const sendMessageToPage = async (api, object) => {
@@ -73,8 +73,8 @@ const sendMessageToPage = async (api, object) => {
73
73
  }
74
74
  });
75
75
  };
76
- /**
77
- * @category Intercom functions
76
+ /**
77
+ * @category Intercom functions
78
78
  */
79
79
  exports.sendMessageToPage = sendMessageToPage;
80
80
  const sendMessageToGroup = async (api, object, groupId) => {
@@ -104,8 +104,8 @@ const sendMessageToGroup = async (api, object, groupId) => {
104
104
  }
105
105
  });
106
106
  };
107
- /**
108
- * @category Intercom functions
107
+ /**
108
+ * @category Intercom functions
109
109
  */
110
110
  exports.sendMessageToGroup = sendMessageToGroup;
111
111
  function sendMessage(endpoint, token, body) {
@@ -12,8 +12,8 @@ const handleVisibilityChange = () => {
12
12
  });
13
13
  };
14
14
 
15
- /**
16
- * @category Event listener
15
+ /**
16
+ * @category Event listener
17
17
  */
18
18
  const addVisibilityChangeListener = callback => {
19
19
  const {
@@ -25,8 +25,8 @@ const addVisibilityChangeListener = callback => {
25
25
  }
26
26
  return id;
27
27
  };
28
- /**
29
- * @category Event listener
28
+ /**
29
+ * @category Event listener
30
30
  */
31
31
  exports.addVisibilityChangeListener = addVisibilityChangeListener;
32
32
  const removeVisibilityChangeListener = id => {
@@ -7,8 +7,8 @@ exports.useGeoLocationListener = exports.useGeoLocation = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _react = require("react");
9
9
  var _ChaynsContext = require("../components/ChaynsContext");
10
- /**
11
- * @category Hooks
10
+ /**
11
+ * @category Hooks
12
12
  */
13
13
  const useGeoLocationListener = () => {
14
14
  const addListener = (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsFunctionsContext, v => v.addGeoLocationListener);
@@ -23,8 +23,8 @@ const useGeoLocationListener = () => {
23
23
  // eslint-disable-next-line react-hooks/exhaustive-deps
24
24
  }, []);
25
25
  };
26
- /**
27
- * @category Hooks
26
+ /**
27
+ * @category Hooks
28
28
  */
29
29
  exports.useGeoLocationListener = useGeoLocationListener;
30
30
  const useGeoLocation = ({
@@ -8,8 +8,8 @@ var _useContextSelector = require("use-context-selector");
8
8
  var _react = require("react");
9
9
  var _ChaynsContext = require("../components/ChaynsContext");
10
10
  var _windowMetricsListener = require("./windowMetricsListener");
11
- /**
12
- * @category Hooks
11
+ /**
12
+ * @category Hooks
13
13
  */
14
14
  const useScrollListener = () => {
15
15
  const addListener = (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsFunctionsContext, v => v.addScrollListener);
@@ -24,8 +24,8 @@ const useScrollListener = () => {
24
24
  // eslint-disable-next-line react-hooks/exhaustive-deps
25
25
  }, []);
26
26
  };
27
- /**
28
- * @category Hooks
27
+ /**
28
+ * @category Hooks
29
29
  */
30
30
  exports.useScrollListener = useScrollListener;
31
31
  const useScrollPosition = ({
@@ -52,8 +52,8 @@ const useScrollPosition = ({
52
52
  }, [getScrollPosition]);
53
53
  return value;
54
54
  };
55
- /**
56
- * @category Hooks
55
+ /**
56
+ * @category Hooks
57
57
  */
58
58
  exports.useScrollPosition = useScrollPosition;
59
59
  const useScrollOffsetTop = ({
@@ -75,8 +75,8 @@ const useScrollOffsetTop = ({
75
75
  }
76
76
  return 0;
77
77
  };
78
- /**
79
- * @category Hooks
78
+ /**
79
+ * @category Hooks
80
80
  */
81
81
  exports.useScrollOffsetTop = useScrollOffsetTop;
82
82
  const useScrollOffsetBottom = ({
@@ -7,8 +7,8 @@ exports.useAccessToken = void 0;
7
7
  var _react = require("react");
8
8
  var _useContextSelector = require("use-context-selector");
9
9
  var _ChaynsContext = require("../components/ChaynsContext");
10
- /**
11
- * @category Hooks
10
+ /**
11
+ * @category Hooks
12
12
  */
13
13
  const useAccessToken = accessToken => {
14
14
  const [token, setToken] = (0, _react.useState)(null);
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useCurrentPage = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useCurrentPage = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v === null || v === void 0 ? void 0 : v.currentPage);
13
13
  exports.useCurrentPage = useCurrentPage;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useCustomData = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useCustomData = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v === null || v === void 0 ? void 0 : v.customData);
13
13
  exports.useCustomData = useCustomData;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useDevice = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useDevice = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v === null || v === void 0 ? void 0 : v.device);
13
13
  exports.useDevice = useDevice;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useEnvironment = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useEnvironment = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v === null || v === void 0 ? void 0 : v.environment);
13
13
  exports.useEnvironment = useEnvironment;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useFunctions = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useFunctions = () => {
13
13
  const t = (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsFunctionsContext, f => f || {});
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useIsAdminMode = void 0;
7
7
  var _useContextSelector2 = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useIsAdminMode = () => {
13
13
  var _useContextSelector;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useLanguage = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useLanguage = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v === null || v === void 0 ? void 0 : v.language);
13
13
  exports.useLanguage = useLanguage;
@@ -7,8 +7,8 @@ exports.usePages = exports.usePage = exports.getPage = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
9
  var _ChaynsProvider = require("../components/ChaynsProvider");
10
- /**
11
- * @category Hooks
10
+ /**
11
+ * @category Hooks
12
12
  */
13
13
  const usePages = ({
14
14
  siteId
@@ -21,8 +21,8 @@ const usePages = ({
21
21
  }
22
22
  return pages;
23
23
  };
24
- /**
25
- * @category Hooks
24
+ /**
25
+ * @category Hooks
26
26
  */
27
27
  exports.usePages = usePages;
28
28
  const usePage = ({
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useParameters = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useParameters = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => (v === null || v === void 0 ? void 0 : v.parameters) || []);
13
13
  exports.useParameters = useParameters;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useSite = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useSite = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v === null || v === void 0 ? void 0 : v.site);
13
13
  exports.useSite = useSite;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useUser = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useUser = () => (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => (v === null || v === void 0 ? void 0 : v.user) || {});
13
13
  exports.useUser = useUser;
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.useValues = void 0;
7
7
  var _useContextSelector = require("use-context-selector");
8
8
  var _ChaynsContext = require("../components/ChaynsContext");
9
- /**
10
- * @category Hooks
9
+ /**
10
+ * @category Hooks
11
11
  */
12
12
  const useValues = () => {
13
13
  const t = (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsContext, v => v || {});
@@ -8,8 +8,8 @@ var _useContextSelector = require("use-context-selector");
8
8
  var _react = require("react");
9
9
  var _ChaynsContext = require("../components/ChaynsContext");
10
10
  var _IChaynsReact = require("../types/IChaynsReact");
11
- /**
12
- * @category Hooks
11
+ /**
12
+ * @category Hooks
13
13
  */
14
14
  const useWindowMetricsListener = () => {
15
15
  const addListener = (0, _useContextSelector.useContextSelector)(_ChaynsContext.ChaynsFunctionsContext, v => v.addWindowMetricsListener);
@@ -24,8 +24,8 @@ const useWindowMetricsListener = () => {
24
24
  // eslint-disable-next-line react-hooks/exhaustive-deps
25
25
  }, []);
26
26
  };
27
- /**
28
- * @category Hooks
27
+ /**
28
+ * @category Hooks
29
29
  */
30
30
  exports.useWindowMetricsListener = useWindowMetricsListener;
31
31
  const useWindowMetrics = ({
@@ -17,7 +17,7 @@ const getDeviceInfo = (userAgent, acceptHeader) => {
17
17
  appName = _IChaynsReact.AppName.David;
18
18
  } else if (match) {
19
19
  appName = _IChaynsReact.AppName.Location;
20
- } else if (/dface|h96pp|h96max|jabiru|chaynsterminal|wayter|odroidn2p/i.test(navigator.userAgent)) {
20
+ } else if (/dface|h96pp|h96max|jabiru|chaynsterminal|wayter|odroidn2p/i.test(userAgent)) {
21
21
  appName = _IChaynsReact.AppName.ChaynsLauncher;
22
22
  }
23
23
  const result = {};
@@ -405,6 +405,11 @@ class AppWrapper {
405
405
  void this.appCall(19, value, {
406
406
  awaitResult: false
407
407
  });
408
+ },
409
+ scrollByY: (value, duration) => {
410
+ window.scrollBy({
411
+ top: value
412
+ });
408
413
  }
409
414
  };
410
415
  async init() {
@@ -229,6 +229,10 @@ class FrameWrapper {
229
229
  vibrate: async value => {
230
230
  if (!this.initialized) await this.ready;
231
231
  return this.exposedFunctions.vibrate(value);
232
+ },
233
+ scrollByY: async (value, duration) => {
234
+ if (!this.initialized) await this.ready;
235
+ return this.exposedFunctions.scrollByY(value, duration);
232
236
  }
233
237
  };
234
238
  initialized = false;
@@ -3,32 +3,32 @@ import { isDate, isNumber, isObject } from './utils/is';
3
3
  import { open } from './open';
4
4
  import { getDevice } from "../index";
5
5
 
6
- /**
7
- * The config object for date dialog
8
- * @typedef {Object} dateConfig
9
- * @property {Date} preSelect - The date object which should be preselected.
10
- * @property {Date} minDate - The min date which you could select.
11
- * @property {Date} maxDate - The max date which you could select.
12
- * @property {dateDialogType} dateType - The type of dialog you want to display.
13
- * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
14
- * @property {string} message - The message that is displayed above the date dialog, only in apps supported
15
- * @property {string} title - The title that is displayed above the message, only in apps supported
6
+ /**
7
+ * The config object for date dialog
8
+ * @typedef {Object} dateConfig
9
+ * @property {Date} preSelect - The date object which should be preselected.
10
+ * @property {Date} minDate - The min date which you could select.
11
+ * @property {Date} maxDate - The max date which you could select.
12
+ * @property {dateDialogType} dateType - The type of dialog you want to display.
13
+ * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
14
+ * @property {string} message - The message that is displayed above the date dialog, only in apps supported
15
+ * @property {string} title - The title that is displayed above the message, only in apps supported
16
16
  */
17
17
 
18
- /**
19
- * This call will open a date select dialog.
20
- * <div>Call: 30</div>
21
- * @param {dateConfig} config - Define the configuration of this call
22
- * @return {Promise} contains a timestamp as result
23
- * @example chayns.dialog.date({
24
- * 'dateType': chayns.dialog.dateType.DATE_TIME,
25
- * 'preSelect': new Date(2018, 6, 14, 0, 0, 0),
26
- * 'minDate': new Date(2018, 6, 1, 15, 0, 0),
27
- * 'maxDate': new Date(2019, 6, 1, 0, 23, 0),
28
- * 'minuteInterval': 15
29
- * ).then(function (data) {
30
- * console.log(data);
31
- * });
18
+ /**
19
+ * This call will open a date select dialog.
20
+ * <div>Call: 30</div>
21
+ * @param {dateConfig} config - Define the configuration of this call
22
+ * @return {Promise} contains a timestamp as result
23
+ * @example chayns.dialog.date({
24
+ * 'dateType': chayns.dialog.dateType.DATE_TIME,
25
+ * 'preSelect': new Date(2018, 6, 14, 0, 0, 0),
26
+ * 'minDate': new Date(2018, 6, 1, 15, 0, 0),
27
+ * 'maxDate': new Date(2019, 6, 1, 0, 23, 0),
28
+ * 'minuteInterval': 15
29
+ * ).then(function (data) {
30
+ * console.log(data);
31
+ * });
32
32
  */
33
33
 
34
34
  export function date() {
@@ -165,18 +165,18 @@ export function advancedDate() {
165
165
  });
166
166
  }
167
167
 
168
- /**
169
- * @typedef {number} dateDialogType
168
+ /**
169
+ * @typedef {number} dateDialogType
170
170
  */
171
171
 
172
- /**
173
- * Enum for date dialog
174
- * <div>DATE will open a dialog where you can select a special day</div>
175
- * <div>TIME will open a dialog where you can only select a special time</div>
176
- * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
177
- * @readonly
178
- * @enum {dateDialogType}
179
- * @type {{DATE: number, TIME: number, DATE_TIME: number}}
172
+ /**
173
+ * Enum for date dialog
174
+ * <div>DATE will open a dialog where you can select a special day</div>
175
+ * <div>TIME will open a dialog where you can only select a special time</div>
176
+ * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
177
+ * @readonly
178
+ * @enum {dateDialogType}
179
+ * @type {{DATE: number, TIME: number, DATE_TIME: number}}
180
180
  */
181
181
  export const dateType = {
182
182
  'DATE': 1,