@integry/sdk 4.7.39 → 4.7.41

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 (267) hide show
  1. package/dist/esm/index.csm.js +1 -1
  2. package/dist/umd/index.umd.js +1 -1
  3. package/package.json +6 -1
  4. package/.eslintignore +0 -1
  5. package/.vscode/launch.json +0 -17
  6. package/CHANGELOG_INTERNAL.md +0 -134
  7. package/README_INTERNAL.md +0 -176
  8. package/THIRD_PARTY_LICENSES +0 -525
  9. package/generateTests.js +0 -80
  10. package/jest.config.cjs +0 -10
  11. package/src/components/AddTagButton/index.ts +0 -23
  12. package/src/components/BasicSelect/index.ts +0 -123
  13. package/src/components/BasicSelect/styles.module.scss +0 -44
  14. package/src/components/Button/index.ts +0 -97
  15. package/src/components/Button/styles.module.scss +0 -152
  16. package/src/components/CheckboxGroup/Checkbox.ts +0 -104
  17. package/src/components/CheckboxGroup/index.ts +0 -190
  18. package/src/components/CheckboxGroup/styles.module.scss +0 -63
  19. package/src/components/CollapsedMenu/index.ts +0 -104
  20. package/src/components/CollapsedMenu/styles.module.scss +0 -46
  21. package/src/components/ConfigureFieldWrapper/index.ts +0 -85
  22. package/src/components/ConfigureFieldWrapper/styles.module.scss +0 -57
  23. package/src/components/EditableText/index.ts +0 -121
  24. package/src/components/EditableText/styles.module.scss +0 -38
  25. package/src/components/EditableTextArea/index.ts +0 -143
  26. package/src/components/EditableTextArea/styles.module.scss +0 -91
  27. package/src/components/ErrorMessage/index.ts +0 -16
  28. package/src/components/ErrorMessage/styles.module.scss +0 -19
  29. package/src/components/ErrorPage/index.ts +0 -42
  30. package/src/components/ErrorPage/styles.module.scss +0 -26
  31. package/src/components/Footer/index.ts +0 -41
  32. package/src/components/Footer/styles.module.scss +0 -40
  33. package/src/components/HTMLContent/index.tsx +0 -205
  34. package/src/components/HTMLContent/styles.module.scss +0 -3
  35. package/src/components/InfoBox/index.ts +0 -48
  36. package/src/components/InfoBox/styles.module.scss +0 -21
  37. package/src/components/Input/BaseInput/index.ts +0 -170
  38. package/src/components/Input/BaseInput/styles.module.scss +0 -95
  39. package/src/components/Input/DateInput/index.ts +0 -103
  40. package/src/components/Input/DateInput/styles.module.scss +0 -50
  41. package/src/components/Input/Input/index.ts +0 -225
  42. package/src/components/Input/Input/styles.module.scss +0 -16
  43. package/src/components/Input/PasswordInput/index.ts +0 -164
  44. package/src/components/Input/PasswordInput/styles.module.scss +0 -37
  45. package/src/components/Input/index.ts +0 -7
  46. package/src/components/Label/index.ts +0 -61
  47. package/src/components/Label/styles.module.scss +0 -41
  48. package/src/components/LargeLoader/index.ts +0 -25
  49. package/src/components/LargeLoader/styles.module.scss +0 -16
  50. package/src/components/Listbox/ListBoxItem.ts +0 -57
  51. package/src/components/Listbox/index.ts +0 -488
  52. package/src/components/Listbox/styles.module.scss +0 -197
  53. package/src/components/Loader/index.ts +0 -25
  54. package/src/components/Loader/styles.module.scss +0 -16
  55. package/src/components/MediaGallery/MediaGalleryModal.ts +0 -82
  56. package/src/components/MediaGallery/MediaSlider.ts +0 -76
  57. package/src/components/MediaGallery/index.ts +0 -92
  58. package/src/components/MediaGallery/styles.module.scss +0 -156
  59. package/src/components/MediaUpload/index.ts +0 -233
  60. package/src/components/MediaUpload/styles.module.scss +0 -118
  61. package/src/components/Modal/index.ts +0 -87
  62. package/src/components/Modal/styles.module.scss +0 -441
  63. package/src/components/MultipurposeField/Dropdown/ListBoxItem.tsx +0 -59
  64. package/src/components/MultipurposeField/Dropdown/index.tsx +0 -1202
  65. package/src/components/MultipurposeField/Dropdown/styles.module.scss +0 -215
  66. package/src/components/MultipurposeField/TagMenu/index.ts +0 -536
  67. package/src/components/MultipurposeField/TagMenu/styles.module.scss +0 -175
  68. package/src/components/MultipurposeField/TagOptions/index.tsx +0 -83
  69. package/src/components/MultipurposeField/TagOptions/styles.module.scss +0 -95
  70. package/src/components/MultipurposeField/index.tsx +0 -944
  71. package/src/components/MultipurposeField/styles.module.scss +0 -77
  72. package/src/components/NewModal/index.ts +0 -69
  73. package/src/components/NewModal/styles.module.scss +0 -70
  74. package/src/components/OverflowTooltip/index.tsx +0 -59
  75. package/src/components/PopUp/ConfirmationPopUp/index.ts +0 -58
  76. package/src/components/PopUp/ConfirmationPopUp/styles.module.scss +0 -49
  77. package/src/components/PopUp/SuccessPopUp/index.ts +0 -62
  78. package/src/components/PopUp/SuccessPopUp/styles.module.scss +0 -38
  79. package/src/components/RadioGroup/Radio.ts +0 -128
  80. package/src/components/RadioGroup/index.ts +0 -169
  81. package/src/components/RadioGroup/styles.module.scss +0 -81
  82. package/src/components/Search/index.ts +0 -69
  83. package/src/components/Search/styles.module.scss +0 -149
  84. package/src/components/TabBar/Tab.ts +0 -33
  85. package/src/components/TabBar/index.ts +0 -64
  86. package/src/components/TabBar/styles.module.scss +0 -43
  87. package/src/components/Tag/index.ts +0 -29
  88. package/src/components/Tag/styles.module.scss +0 -57
  89. package/src/components/TagsMenu/index.ts +0 -1697
  90. package/src/components/TagsMenu/styles.module.scss +0 -350
  91. package/src/components/TestComponent/index.ts +0 -71
  92. package/src/components/TestComponent/styles.module.scss +0 -152
  93. package/src/components/TextArea/index.ts +0 -172
  94. package/src/components/TextArea/styles.module.scss +0 -72
  95. package/src/components/TextContent/index.tsx +0 -128
  96. package/src/components/TextContent/styles.module.scss +0 -6
  97. package/src/components/ThreeDotLoader/index.ts +0 -39
  98. package/src/components/ThreeDotLoader/styles.module.scss +0 -41
  99. package/src/components/TimeInput/index.ts +0 -129
  100. package/src/components/TimeInput/styles.module.scss +0 -16
  101. package/src/components/Toggle/index.ts +0 -34
  102. package/src/components/Toggle/styles.module.scss +0 -56
  103. package/src/components/Toggle-v2/index.ts +0 -40
  104. package/src/components/Toggle-v2/styles.module.scss +0 -86
  105. package/src/components/Tooltip/index.ts +0 -271
  106. package/src/components/Tooltip/styles.module.scss +0 -105
  107. package/src/components/form/FunctionField/index.ts +0 -816
  108. package/src/components/form/FunctionField/styles.module.scss +0 -478
  109. package/src/components/form/ObjectField/__snapshots__/index.ts.test.tsx.snap +0 -3
  110. package/src/components/form/ObjectField/index.ts +0 -593
  111. package/src/components/form/ObjectField/index.ts.test.tsx +0 -213
  112. package/src/components/form/ObjectField/styles.module.scss +0 -103
  113. package/src/components/form/index.ts +0 -4
  114. package/src/contexts/AppContext.ts +0 -12
  115. package/src/declaration.d.ts +0 -7
  116. package/src/extensions/HMAC.ts +0 -25
  117. package/src/extensions/IntegryAPIError.ts +0 -19
  118. package/src/features/common/AccountDropdown/index.ts +0 -291
  119. package/src/features/common/AccountDropdown/styles.module.scss +0 -19
  120. package/src/features/common/ActionForm/index.ts +0 -2602
  121. package/src/features/common/ActionForm/styles.module.scss +0 -35
  122. package/src/features/common/AppCard/index.ts +0 -207
  123. package/src/features/common/AppCard/styles.module.scss +0 -117
  124. package/src/features/common/AppCardCompact/index.ts +0 -189
  125. package/src/features/common/AppCardCompact/styles.module.scss +0 -141
  126. package/src/features/common/AuthSelector/index.ts +0 -537
  127. package/src/features/common/AuthSelector/styles.module.scss +0 -161
  128. package/src/features/common/AuthSelectorCompact/index.ts +0 -706
  129. package/src/features/common/AuthSelectorCompact/styles.module.scss +0 -219
  130. package/src/features/common/AuthSelectorDropdown/index.ts +0 -704
  131. package/src/features/common/AuthSelectorDropdown/styles.module.scss +0 -361
  132. package/src/features/common/AuthSelectorV2/index.ts +0 -336
  133. package/src/features/common/AuthSelectorV2/styles.module.scss +0 -235
  134. package/src/features/common/DynamicField/index.ts +0 -402
  135. package/src/features/common/DynamicField/styles.module.scss +0 -266
  136. package/src/features/common/DynamicTypedField/index.ts +0 -504
  137. package/src/features/common/DynamicTypedField/styles.module.scss +0 -135
  138. package/src/features/common/FunctionForm/index.ts +0 -1095
  139. package/src/features/common/FunctionForm/styles.module.scss +0 -225
  140. package/src/features/common/MappingUI/index.ts +0 -649
  141. package/src/features/common/MappingUI/styles.module.scss +0 -121
  142. package/src/features/common/MarketplaceAppCard/index.ts +0 -279
  143. package/src/features/common/MarketplaceAppCard/styles.module.scss +0 -231
  144. package/src/features/common/MarketplaceAppCardCompact/index.ts +0 -283
  145. package/src/features/common/MarketplaceAppCardCompact/styles.module.scss +0 -255
  146. package/src/features/common/NewMappingUI/index.ts +0 -515
  147. package/src/features/common/NewMappingUI/styles.module.scss +0 -113
  148. package/src/features/common/RequestAppWidget/RequestAppModal/index.ts +0 -67
  149. package/src/features/common/RequestAppWidget/RequestAppModal/styles.module.scss +0 -23
  150. package/src/features/common/RequestAppWidget/index.ts +0 -48
  151. package/src/features/common/RequestAppWidget/request-app-form.ts +0 -89
  152. package/src/features/common/RequestAppWidget/styles.module.scss +0 -43
  153. package/src/features/common/SectionField/index.ts +0 -272
  154. package/src/features/common/SectionField/styles.module.scss +0 -67
  155. package/src/features/common/Step/index.ts +0 -827
  156. package/src/features/common/Step/styles.module.scss +0 -12
  157. package/src/features/common/StepNavigation/CollapsedSteps.ts +0 -131
  158. package/src/features/common/StepNavigation/NavItem.ts +0 -111
  159. package/src/features/common/StepNavigation/index.ts +0 -261
  160. package/src/features/common/StepNavigation/styles.module.scss +0 -117
  161. package/src/features/common/Steps/index.ts +0 -1140
  162. package/src/features/common/Steps/styles.module.scss +0 -314
  163. package/src/features/containers/AppFlowContainer/AppFlowListing/compactStyles.module.scss +0 -404
  164. package/src/features/containers/AppFlowContainer/AppFlowListing/flow-instance.tsx +0 -367
  165. package/src/features/containers/AppFlowContainer/AppFlowListing/flowCard.test.tsx +0 -58
  166. package/src/features/containers/AppFlowContainer/AppFlowListing/flowCard.tsx +0 -208
  167. package/src/features/containers/AppFlowContainer/AppFlowListing/flowCardCompact.test.tsx +0 -49
  168. package/src/features/containers/AppFlowContainer/AppFlowListing/flowCardCompact.tsx +0 -421
  169. package/src/features/containers/AppFlowContainer/AppFlowListing/flowInstanceCompact.tsx +0 -577
  170. package/src/features/containers/AppFlowContainer/AppFlowListing/index.tsx +0 -83
  171. package/src/features/containers/AppFlowContainer/AppFlowListing/styles.module.scss +0 -233
  172. package/src/features/containers/AppFlowContainer/AppFlowWrap/app-page-loader.tsx +0 -45
  173. package/src/features/containers/AppFlowContainer/AppFlowWrap/index.tsx +0 -1085
  174. package/src/features/containers/AppFlowContainer/AppFlowWrap/styles.module.scss +0 -465
  175. package/src/features/containers/AppFlowContainer/Authentication/index.ts +0 -610
  176. package/src/features/containers/AppFlowContainer/Authentication/styles.module.scss +0 -468
  177. package/src/features/containers/AppFlowContainer/index.ts +0 -114
  178. package/src/features/containers/AppPageContainer/AppPage/index.tsx +0 -262
  179. package/src/features/containers/AppPageContainer/AppPage/styles.module.scss +0 -120
  180. package/src/features/containers/AppPageContainer/IntegrationCard/index.ts +0 -165
  181. package/src/features/containers/AppPageContainer/IntegrationCard/styles.module.scss +0 -81
  182. package/src/features/containers/AppPageContainer/index.tsx +0 -93
  183. package/src/features/containers/AppPageContainer/styles.module.scss +0 -0
  184. package/src/features/containers/AppsForFlows/index.ts +0 -161
  185. package/src/features/containers/AppsForFlows/styles.module.scss +0 -280
  186. package/src/features/containers/AppsForFlowsCompact/index.ts +0 -161
  187. package/src/features/containers/AppsForFlowsCompact/styles.module.scss +0 -279
  188. package/src/features/containers/AuthSetupContainer/AppSelection.ts +0 -73
  189. package/src/features/containers/AuthSetupContainer/AuthTypeSelection.ts +0 -67
  190. package/src/features/containers/AuthSetupContainer/Footer.ts +0 -32
  191. package/src/features/containers/AuthSetupContainer/Header.ts +0 -39
  192. package/src/features/containers/AuthSetupContainer/PostAdditionPopup.ts +0 -27
  193. package/src/features/containers/AuthSetupContainer/index.ts +0 -349
  194. package/src/features/containers/AuthSetupContainer/styles.module.scss +0 -229
  195. package/src/features/containers/FlowSetupContainer/index.ts +0 -391
  196. package/src/features/containers/FlowSetupContainer/styles.module.scss +0 -18
  197. package/src/features/containers/MarkeplaceApps/index.ts +0 -583
  198. package/src/features/containers/MarkeplaceApps/styles.module.scss +0 -558
  199. package/src/features/containers/MarketplaceAppsCompact/index.ts +0 -585
  200. package/src/features/containers/MarketplaceAppsCompact/styles.module.scss +0 -563
  201. package/src/features/containers/MarketplaceAppsContainer/index.ts +0 -91
  202. package/src/features/containers/MarketplaceContainer/AppCard/index.ts +0 -91
  203. package/src/features/containers/MarketplaceContainer/AppCard/styles.module.scss +0 -66
  204. package/src/features/containers/MarketplaceContainer/AppListing/index.ts +0 -34
  205. package/src/features/containers/MarketplaceContainer/AppListing/styles.module.scss +0 -10
  206. package/src/features/containers/MarketplaceContainer/MarketplaceContentWrap/index.ts +0 -132
  207. package/src/features/containers/MarketplaceContainer/MarketplaceContentWrap/styles.module.scss +0 -117
  208. package/src/features/containers/MarketplaceContainer/index.ts +0 -242
  209. package/src/features/containers/MarketplaceContainer/styles.module.scss +0 -84
  210. package/src/features/containers/SDKContainer/index.ts +0 -817
  211. package/src/features/containers/SDKContainer/styles.module.scss +0 -266
  212. package/src/features/containers/SDKDebugContainer/index.ts +0 -137
  213. package/src/features/containers/SDKDebugContainer/styles.module.scss +0 -37
  214. package/src/features/containers/SDKFailedContainer/index.ts +0 -117
  215. package/src/features/containers/SDKFailedContainer/styles.module.scss +0 -57
  216. package/src/features/integrations/IntegrationRow/Icons.ts +0 -77
  217. package/src/features/integrations/IntegrationRow/index.ts +0 -129
  218. package/src/features/integrations/IntegrationRow/styles.module.scss +0 -62
  219. package/src/features/integrations/IntegrationsHeader/index.ts +0 -34
  220. package/src/features/integrations/IntegrationsHeader/styles.module.scss +0 -47
  221. package/src/features/integrations/IntegrationsList/index.ts +0 -252
  222. package/src/features/integrations/IntegrationsList/styles.module.scss +0 -67
  223. package/src/features/templates/Template/index.ts +0 -295
  224. package/src/features/templates/Template/styles.module.scss +0 -226
  225. package/src/features/templates/TemplatesView/index.ts +0 -368
  226. package/src/features/templates/TemplatesView/styles.module.scss +0 -71
  227. package/src/features/templates/TemplatesViewCompact/index.ts +0 -364
  228. package/src/features/templates/TemplatesViewCompact/styles.module.scss +0 -141
  229. package/src/hooks/useAutosizeTextArea.ts +0 -22
  230. package/src/hooks/useCustomRef.ts +0 -13
  231. package/src/hooks/useDebounce.ts +0 -17
  232. package/src/hooks/useElementResize.ts +0 -40
  233. package/src/hooks/useEventListener.ts +0 -42
  234. package/src/hooks/useHover.ts +0 -40
  235. package/src/hooks/useOnClickOutside.ts +0 -32
  236. package/src/index.ts +0 -2244
  237. package/src/index.umd.ts +0 -13
  238. package/src/interfaces/index.ts +0 -938
  239. package/src/modules/api/index.ts +0 -1325
  240. package/src/modules/api/responseHandler.ts +0 -38
  241. package/src/modules/event-emitter/index.ts +0 -72
  242. package/src/modules/event-emitter/runners/abstract.ts +0 -21
  243. package/src/modules/event-emitter/runners/default.ts +0 -11
  244. package/src/modules/event-emitter/runners/ntimes.ts +0 -28
  245. package/src/modules/event-emitter/types.ts +0 -34
  246. package/src/store/actionFunctions.ts +0 -1578
  247. package/src/store/index.ts +0 -17
  248. package/src/store/initialState.ts +0 -58
  249. package/src/types/index.ts +0 -320
  250. package/src/types/preact-compat.d.ts +0 -4
  251. package/src/types/store.ts +0 -366
  252. package/src/types/utils.ts +0 -19
  253. package/src/utils/ActivityOutputUtils.ts +0 -176
  254. package/src/utils/common.ts +0 -20
  255. package/src/utils/copyToClipboard.ts +0 -24
  256. package/src/utils/datetime.ts +0 -101
  257. package/src/utils/getUrlParam.ts +0 -11
  258. package/src/utils/isAuthMessage.ts +0 -16
  259. package/src/utils/isBrowser.ts +0 -1
  260. package/src/utils/jsonEncodeDecode.ts +0 -15
  261. package/src/utils/objectUtils.ts +0 -117
  262. package/src/utils/popup.ts +0 -30
  263. package/src/utils/searchJson.ts +0 -51
  264. package/src/utils/stepUtils.ts +0 -45
  265. package/src/utils/truncate.ts +0 -6
  266. package/test/setup.ts +0 -1
  267. package/vitest.config.ts +0 -16
package/package.json CHANGED
@@ -1,10 +1,15 @@
1
1
  {
2
2
  "name": "@integry/sdk",
3
- "version": "4.7.39",
3
+ "version": "4.7.41",
4
4
  "description": "Integry SDK",
5
5
  "main": "dist/umd/index.umd.js",
6
6
  "module": "dist/esm/index.csm.js",
7
7
  "types": "dist/esm/index.csm.d.ts",
8
+ "files": [
9
+ "dist",
10
+ "README.md",
11
+ "LICENSE"
12
+ ],
8
13
  "scripts": {
9
14
  "bump": "bump -t \"sdk-release-v%s\" -c \"SDK release v%s\"",
10
15
  "lint": "eslint src --ext .js --ext .ts",
package/.eslintignore DELETED
@@ -1 +0,0 @@
1
- **/*.test.ts
@@ -1,17 +0,0 @@
1
- {
2
- // Use IntelliSense to learn about possible attributes.
3
- // Hover to view descriptions of existing attributes.
4
- // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5
- "version": "0.2.0",
6
- "configurations": [
7
- {
8
- "type": "chrome",
9
- "request": "launch",
10
- "name": "Open Integry SDK sample code (44).html",
11
- // "file": "/Users/yasir/Downloads/Flows - Integry SDK sample (41).html"
12
- "file": "/Users/yasir/Downloads/Integry SDK sample code (73).html"
13
- // "file": "/Users/yasir/Downloads/Flows of an app - Integry SDK sample (Thryv 7) For All (2).html"
14
- // "file": "/Users/yasir/Downloads/Integry SDK sample code (64).html"
15
- }
16
- ]
17
- }
@@ -1,134 +0,0 @@
1
- # Changelog
2
-
3
- All notable changes to this project will be documented in this file.
4
-
5
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
-
8
-
9
- ## [3.9.1] - 2023-10-24
10
-
11
- ## Fixed
12
-
13
- - Fixed the search not working properly for flows listing.
14
-
15
- ## [3.9.0] - 2023-10-24
16
-
17
- ## Changed
18
-
19
- - Changed the sequence of flow setup form to show all connect screens first.
20
-
21
- ## [3.7.18] - 2023-10-04
22
-
23
- ## Added
24
-
25
- - Added loading spinner while deleting an integration from "flows of an app" view.
26
-
27
- ## [3.7.16] - 2023-10-03
28
-
29
- ## Added
30
-
31
- - Added feature to allow deleting an integration from "flows of an app" view.
32
-
33
- ## [3.7.15] - 2023-09-28
34
-
35
- ## Changed
36
-
37
- - Rebrand Instance as Integrations on flow list screen.
38
-
39
- ## [3.7.14] - 2023-09-26
40
-
41
- ## Added
42
-
43
- - Add App icon in "All Flows" view of SDK.
44
-
45
- ## [3.7.12] - 2023-09-20
46
-
47
- ## Changed
48
-
49
- - Show host app step when API key is not provided in SDK config.
50
-
51
- ## [3.7.11] - 2023-09-19
52
-
53
- ## Added
54
-
55
- - Added `options` object to pass SDK options like `tags` and `title`.
56
-
57
- ## [3.7.10] - 2023-09-19
58
-
59
- ## Changed
60
-
61
- - `title` field will be used to set title of all SDK views.
62
-
63
- ## [3.7.7] - 2023-09-19
64
-
65
- ## Fixed
66
-
67
- - Minor bug fixes
68
-
69
- ## [3.7.7] - 2023-09-19
70
-
71
- ### Added
72
-
73
- - Added support for deployment ID for legacy users. When a deployment ID is provided to the SDK, only `Published` flows will be listed.
74
-
75
- ## [3.7.6] - 2023-09-18
76
-
77
- ### Changed
78
-
79
- - Updated SDK button color to Integry blue.
80
-
81
- ## [3.7.4] - 2023-09-18
82
-
83
- ### Changed
84
-
85
- - Made deployment ID optional in SDK config.
86
-
87
- ## [3.7.2] - 2023-09-18
88
-
89
- ### Added
90
-
91
- - Refreshed SDK when authorization is deleted using the `removeAuthorization` function.
92
-
93
- ## [3.7.1] - 2023-09-14
94
-
95
- ### Added
96
-
97
- - Added 'did-app-load' event when App loading is completed.
98
-
99
- ## [3.6.9] - 2023-09-15
100
-
101
- ### Added
102
-
103
- - Added a function called `removeAuthorization` to delete end-user authorization.
104
-
105
- ## [3.6.7] - 2023-09-09
106
-
107
- ### Changed
108
-
109
- - Changed button label to "Setup" for "Save and Execute Later" On-Demand Flow.
110
-
111
- ## [3.6.3] - 2023-09-08
112
-
113
- ### Fixed
114
-
115
- - Hidden Tooltip on Flow setup button after account verification is completed.
116
-
117
- ## [3.6.2] - 2023-09-08
118
-
119
- ### Added
120
-
121
- - Added support to execute On-Demand Flow on save if Flow is configured as "Save and Execute."
122
- - Objects passed in SDK configuration will be used as a payload when executing On-Demand Flow.
123
-
124
- ## [3.6.1] - 2023-09-08
125
-
126
- ### Fixed
127
-
128
- - Minor UI Fixes.
129
-
130
- ## [3.6.0] - 2023-09-07
131
-
132
- ### Added
133
-
134
- - Added support for SDK to accept Objects in SDK configuration for Incoming Webhook. These Objects will be used for field mapping.
@@ -1,176 +0,0 @@
1
- # Integry SDK
2
-
3
- ## General features
4
-
5
- - No extra dependencies needed, drastically reduced bundle size
6
- - No transpilation steps needed
7
- - Vanilla JS implementation
8
- - Improved documentation
9
- - Available as a package on NPM
10
- - Can be embedded using a script tag
11
- - Built-in Typescript support
12
- - More powerful events management
13
- - Multi-level customization. Start with built in components and layouts.
14
- - Multiple render modes including inline rendering, modal support and detached rendering where we decouple the views from one another
15
- - Discover more customization options starting from simple CSS overrides to extending and implementing your own custom widgets
16
-
17
- ## Tech stack
18
-
19
- - [Preact](https://github.com/developit/preact)
20
- - [htm](https://github.com/developit/htm)
21
- - [Unistore](https://github.com/developit/unistore)
22
- - [Rollup](https://rollupjs.org/)
23
- - NodeJS
24
- - Yarn
25
-
26
- ## Directory structure
27
-
28
- ```
29
- .
30
- ├── dist # Compiled files
31
- ├── examples # Example projects using SDK
32
- ├── playground # HTML files covering different debug scenarios
33
- ├── sdk-docs # `Docusaurus` documentation site for SDK
34
- ├── src # Source files
35
- │ ├── components # Preact components used in the SDK
36
- │ ├── contexts # Preact contexts used in the SDK
37
- │ ├── extensions # SDK HMAC and API extensions
38
- │ ├── features # Directory-wise breakdown of different SDK views
39
- │ ├── hooks # Preact hooks
40
- │ ├── interfaces # Typescript interfaces
41
- │ ├── modules # API and event emitter live here
42
- │ ├── store # SDK data store setup
43
- │ ├── types # Typescript types live here
44
- │ ├── utils # Utilities used in the SDK
45
- │ ├── index.ts # JS Modules entry point
46
- │ └── index.umd.ts # UMD entry point
47
- ├── types # General Typescript types for rollup
48
- ├── rollup.config.js # Rollup configuration
49
- ├── tsconfig.json # TS configuration
50
- └── README.md
51
- ```
52
-
53
- ## Setting up your development environment
54
-
55
- ### Pre-requisites
56
-
57
- 1. NodeJS
58
- 2. yarn
59
-
60
- ### Starting the local environment
61
-
62
- 1. `cd` into the SDK root directory which is located at `<repo_root>/sdk-v3`
63
- 2. Install dependencies by running `yarn install`
64
- 3. Start the local development environment by running `yarn start`
65
- 4. The development server will start at http://localhost:10001
66
-
67
- ### Choosing which mode to debug
68
-
69
- The SDK has multiple playground HTML files to work on different areas. Each html file lives in the `sdk-v3/playground` directory and contains code which sets up the SDK and calls different methods. You can edit these files to debug different aspects of the SDK.
70
-
71
- 1. http://localhost:10001/index.html
72
-
73
- You can use this playground to debug a normal SDK embed which starts from the Flows listing page. You can click on a Flow and setup integrations. You can select from the tabs at the top to either view available Flows or view existing integrations.
74
-
75
- 2. http://localhost:10001/template.html
76
-
77
- You can use this playground to directly open a Flow.
78
-
79
- 3. http://localhost:10001/auths.html
80
-
81
- You can use this playground to work on the app account management feature provided by the SDK.
82
-
83
- ## Development
84
-
85
- ### Hot reloading
86
-
87
- When you make a change to the code in development mode, Rollup will automatically re-compile the code. After it is done, you will have to refresh the page to see the latest changes.
88
-
89
- ### Debugging using Redux Devtools
90
-
91
- The SDK supports Redux Devtools to look into the internal state and debug actions. Devtools are enabled by default and can be enabled/disabled in the `src/store/index.ts` file. To use the devtools, install the Redux Devtools extension, open the developer tools in your browser and then refresh the SDK playground page.
92
-
93
- ### Styling
94
-
95
- Styles are co-located with each component in a `styles.module.scss` file. This is then imported into a component and used.
96
-
97
- ```tsx
98
- import styles from './styles.module.scss';
99
-
100
- <div class=${styles.selectWrapper} />
101
- ```
102
-
103
- ## Debugging certain features
104
-
105
- ### API Calls
106
-
107
- All API calls are centrally located inside the directory: `src/modules/api/index.ts`.
108
-
109
- ### Manage app accounts
110
-
111
- The code for the manage app accounts feature starts with the `index.ts` entry point.
112
-
113
- ```ts
114
- /**
115
- * Render the account connection modal
116
- * @param data
117
- */
118
- public renderAccountConnectionModal = (data?: {
119
- deploymentId?: string;
120
- appId?: number;
121
- authTypeId?: number;
122
- }): void => {
123
- //
124
- }
125
- ```
126
-
127
- This function sets up our render destination inside the HTML, initializes the store and finally calls the Preact `render` method to render the `AuthSetupContainer` component inside the target container.
128
-
129
- All of the code for managing app accounts feature is located in `src/features/containers/AuthSetupContainer`.
130
-
131
- ```
132
- . AuthSetupContainer
133
- ├── AppSelection.ts # Renders the app selection screen
134
- ├── AuthTypeSelection.ts # Renders the auth type selection screen
135
- ├── Footer.ts # Renders the footer inside auth type selection
136
- ├── Header.ts # Renders the header which shows step title and close icon
137
- ├── index.ts # Wraps the entire feature with state and API calls
138
- └── PostAdditionPopup.ts # Renders the modal which appears after we add an auth
139
- ```
140
-
141
- ### Flow setup
142
-
143
- The code for flow setup starts with the `index.ts` entry point.
144
-
145
- ```ts
146
- /**
147
- * Render the flow setup form we ship
148
- * @param data
149
- */
150
- public renderFlowSetupForm = (data: {
151
- flowId?: string;
152
- flowContainerId: string;
153
- }): void => {
154
- //
155
- }
156
- ```
157
-
158
- This function sets up our render destination inside the HTML, initializes the store and finally calls the Preact `render` method to render the `FlowSetupContainer` component inside the target container.
159
-
160
- All of the code for rendering a Flow setup form is located in `src/features/containers/FlowSetupContainer/index.ts`.
161
-
162
- ### Normal SDK embed
163
-
164
- The code for the normal SDK embed setup starts with the `index.ts` entry point.
165
-
166
- ```ts
167
- /**
168
- *
169
- * @param initConfig
170
- */
171
- public init = (initConfig: InitConfig) => {}
172
- ```
173
-
174
- This function sets up our render destination inside the HTML, initializes the store and finally calls the Preact `render` method to render the `SDKContainer` component inside the target container.
175
-
176
- All of the code for rendering a the normal SDK embed is located in `src/features/containers/SDKContainer/index.ts`.