@blackbaud/sky-addin-client 1.2.0 → 1.2.1

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 (85) hide show
  1. package/CHANGELOG.md +121 -118
  2. package/README.md +470 -470
  3. package/bundles/sky-addin-client.global-es2015.js +851 -851
  4. package/bundles/sky-addin-client.global-es2015.min.js +1 -1
  5. package/bundles/sky-addin-client.global.js +863 -863
  6. package/bundles/sky-addin-client.global.min.js +1 -1
  7. package/bundles/sky-addin-client.umd-es2015.js +851 -851
  8. package/bundles/sky-addin-client.umd-es2015.min.js +1 -1
  9. package/bundles/sky-addin-client.umd.js +863 -863
  10. package/bundles/sky-addin-client.umd.min.js +1 -1
  11. package/index.d.ts +1 -1
  12. package/index.js +17 -17
  13. package/package.json +67 -67
  14. package/src/addin/addin-client.d.ts +277 -277
  15. package/src/addin/addin-client.js +640 -640
  16. package/src/addin/addin-client.spec.d.ts +1 -1
  17. package/src/addin/addin-client.spec.js +1414 -1414
  18. package/src/addin/client-interfaces/addin-action-button-config.d.ts +10 -10
  19. package/src/addin/client-interfaces/addin-action-button-config.js +2 -2
  20. package/src/addin/client-interfaces/addin-button-config.d.ts +10 -10
  21. package/src/addin/client-interfaces/addin-button-config.js +2 -2
  22. package/src/addin/client-interfaces/addin-button-style.d.ts +6 -6
  23. package/src/addin/client-interfaces/addin-button-style.js +17 -17
  24. package/src/addin/client-interfaces/addin-client-args.d.ts +10 -10
  25. package/src/addin/client-interfaces/addin-client-args.js +2 -2
  26. package/src/addin/client-interfaces/addin-client-callbacks.d.ts +40 -40
  27. package/src/addin/client-interfaces/addin-client-callbacks.js +2 -2
  28. package/src/addin/client-interfaces/addin-client-close-modal-args.d.ts +10 -10
  29. package/src/addin/client-interfaces/addin-client-close-modal-args.js +2 -2
  30. package/src/addin/client-interfaces/addin-client-event-args.d.ts +13 -13
  31. package/src/addin/client-interfaces/addin-client-event-args.js +2 -2
  32. package/src/addin/client-interfaces/addin-client-flyout-permalink.d.ts +14 -14
  33. package/src/addin/client-interfaces/addin-client-flyout-permalink.js +2 -2
  34. package/src/addin/client-interfaces/addin-client-init-args.d.ts +28 -28
  35. package/src/addin/client-interfaces/addin-client-init-args.js +2 -2
  36. package/src/addin/client-interfaces/addin-client-navigate-args.d.ts +9 -9
  37. package/src/addin/client-interfaces/addin-client-navigate-args.js +2 -2
  38. package/src/addin/client-interfaces/addin-client-open-help-args.d.ts +10 -10
  39. package/src/addin/client-interfaces/addin-client-open-help-args.js +2 -2
  40. package/src/addin/client-interfaces/addin-client-ready-args.d.ts +39 -39
  41. package/src/addin/client-interfaces/addin-client-ready-args.js +2 -2
  42. package/src/addin/client-interfaces/addin-client-ready-button-config.d.ts +10 -10
  43. package/src/addin/client-interfaces/addin-client-ready-button-config.js +2 -2
  44. package/src/addin/client-interfaces/addin-client-show-confirm-args.d.ts +19 -19
  45. package/src/addin/client-interfaces/addin-client-show-confirm-args.js +2 -2
  46. package/src/addin/client-interfaces/addin-client-show-error-args.d.ts +18 -18
  47. package/src/addin/client-interfaces/addin-client-show-error-args.js +2 -2
  48. package/src/addin/client-interfaces/addin-client-show-flyout-args.d.ts +46 -46
  49. package/src/addin/client-interfaces/addin-client-show-flyout-args.js +2 -2
  50. package/src/addin/client-interfaces/addin-client-show-flyout-result.d.ts +9 -9
  51. package/src/addin/client-interfaces/addin-client-show-flyout-result.js +2 -2
  52. package/src/addin/client-interfaces/addin-client-show-modal-args.d.ts +14 -14
  53. package/src/addin/client-interfaces/addin-client-show-modal-args.js +2 -2
  54. package/src/addin/client-interfaces/addin-client-show-modal-result.d.ts +10 -10
  55. package/src/addin/client-interfaces/addin-client-show-modal-result.js +2 -2
  56. package/src/addin/client-interfaces/addin-client-show-toast-args.d.ts +15 -15
  57. package/src/addin/client-interfaces/addin-client-show-toast-args.js +2 -2
  58. package/src/addin/client-interfaces/addin-client-theme-settings.d.ts +13 -13
  59. package/src/addin/client-interfaces/addin-client-theme-settings.js +2 -2
  60. package/src/addin/client-interfaces/addin-confirm-button-style.d.ts +8 -8
  61. package/src/addin/client-interfaces/addin-confirm-button-style.js +16 -16
  62. package/src/addin/client-interfaces/addin-confirm-button.d.ts +26 -26
  63. package/src/addin/client-interfaces/addin-confirm-button.js +2 -2
  64. package/src/addin/client-interfaces/addin-modal-config.d.ts +12 -12
  65. package/src/addin/client-interfaces/addin-modal-config.js +2 -2
  66. package/src/addin/client-interfaces/addin-tab-config.d.ts +9 -9
  67. package/src/addin/client-interfaces/addin-tab-config.js +2 -2
  68. package/src/addin/client-interfaces/addin-tab-summary-style.d.ts +4 -4
  69. package/src/addin/client-interfaces/addin-tab-summary-style.js +13 -13
  70. package/src/addin/client-interfaces/addin-tile-config.d.ts +32 -32
  71. package/src/addin/client-interfaces/addin-tile-config.js +2 -2
  72. package/src/addin/client-interfaces/addin-tile-summary-style.d.ts +5 -5
  73. package/src/addin/client-interfaces/addin-tile-summary-style.js +15 -15
  74. package/src/addin/client-interfaces/addin-toast-style.d.ts +6 -6
  75. package/src/addin/client-interfaces/addin-toast-style.js +17 -17
  76. package/src/addin/client-interfaces/index.d.ts +27 -27
  77. package/src/addin/client-interfaces/index.js +43 -43
  78. package/src/addin/host-interfaces/addin-host-message-event-data.d.ts +23 -23
  79. package/src/addin/host-interfaces/addin-host-message-event-data.js +2 -2
  80. package/src/addin/host-interfaces/addin-host-message.d.ts +44 -44
  81. package/src/addin/host-interfaces/addin-host-message.js +2 -2
  82. package/src/addin/host-interfaces/index.d.ts +2 -2
  83. package/src/addin/host-interfaces/index.js +18 -18
  84. package/src/addin/index.d.ts +3 -3
  85. package/src/addin/index.js +19 -19
package/CHANGELOG.md CHANGED
@@ -1,118 +1,121 @@
1
- # 1.2.0 (2023-09-27)
2
- ### Behavior change
3
- - Allow host page to determine default values for flyout widths when not provided.
4
-
5
- # 1.1.5 (2023-02-15)
6
- - Add `themeChange` callback to indicate when the add-in host page UX theme changes.
7
-
8
- # 1.1.4 (2023-01-11)
9
- - Add `actionButtonConfig` and `tabConfig` to AddinClientReadyArgs.
10
-
11
- # 1.1.3 (2022-05-12)
12
- - Updated `allowedOrigins` to support Education Management
13
-
14
- # 1.1.2 (2022-02-01)
15
- - Updated `allowedOrigins` to support congregant portal
16
-
17
- # 1.1.1 (2021-06-01)
18
- - Add support for sending custom events to the add-in host page.
19
-
20
- # 1.1.0 (2020-11-19)
21
- - Deprecate help widget related functionality.
22
-
23
- # 1.0.21 (2020-11-04)
24
- - Add support for event handler to process blocking events from the add-in host.
25
-
26
- # 1.0.20 (2020-07-28)
27
- - Add event handler for processing events sent from the add-in host.
28
-
29
- # 1.0.19 (2020-07-07)
30
- - Updated `allowedOrigins` to support Luminate Online
31
-
32
- # 1.0.18 (2020-06-04)
33
- - Fixed a bug where localhost required a port in the allowed origins list. [#40](https://github.com/blackbaud/sky-addin-client/pull/40) (Thanks [@MatthewMazaika](https://github.com/MatthewMazaika)!)
34
-
35
- # 1.0.17 (2020-05-06)
36
- - Added `updateContext` callback to notify add-in when context information has been updated.
37
-
38
-
39
- # 1.0.16 (2020-04-22)
40
- - Added `showWait` and `hideWait` methods to allow developers to show/hide a page-blocking-wait, respectively.
41
-
42
- # 1.0.15 (2020-04-02)
43
-
44
- - Updated `devDependencies` and instructions for consuming from CDN.
45
-
46
- # 1.0.14 (2020-03-04)
47
-
48
- - Added `AddinModalConfig` with optional `fullPage` property (Default: false) to indicate if a modal add-in will be
49
- displayed full page.
50
-
51
- # 1.0.13 (2019-10-04)
52
-
53
- - Added `removeInset` property to `AddinTileConfig` to specify whether the tile content inset should be removed
54
- which allows the content to extend all the way to the edge of the tile container (Default: false)
55
-
56
- # 1.0.12 (2019-05-14)
57
-
58
- - Added a `showConfirm` method to allow developers to show a confirm dialog with a title, description body,
59
- and button configuration containing custom actions to return when the dialog closes.
60
- - Added a `showError` method to allow developers to show an error dialog with a title, error description, and
61
- text for the close button.
62
-
63
- # 1.0.11 (2019-05-03)
64
-
65
- - Added a `closeFlyout` method to allow developers to close a flyout panel.
66
- - The `showFlyout` method will now return a Promise which will resolve when the flyout is closed.
67
-
68
- # 1.0.10 (2019-04-16)
69
-
70
- - Added a `showFlyout` method to allow developers to display supplementary information in a flyout panel.
71
-
72
- # 1.0.9 (2019-03-01)
73
-
74
- - Added a `showToast` method to allow developers to show a toast with a provided message and toast style.
75
-
76
- # 1.0.8 (2019-02-13)
77
-
78
- - To remove confusion and clarify the intent, we've added a new method named `getUserIdentityToken`. This method is
79
- used to obtain a user identity token from the host application and replaces the `getAuthToken` method (which is still
80
- functional but marked as deprecated).
81
-
82
- - Added tile config options to allow developers to provide additional metadata, such as tile summary details and whether
83
- to show a tile's help or settings icons.
84
-
85
- - Added `helpClick` and `settingsClick` callbacks to allow developers to take action when the tile help and settings
86
- icons (respectfully) are clicked.
87
-
88
- # 1.0.7 (2019-02-01)
89
-
90
- - Added a `buttonClick` callback for Button Add-ins to allow developers to take action when buttons are clicked.
91
-
92
- - Added button config options to support Button Add-ins. This allows developers to provide `style` metadata -
93
- essentially, the button's intent as it relates to CRUD operations (add, edit, delete). We will add more "styles" as
94
- requested.
95
-
96
- # 1.0.3 (2018-09-28)
97
-
98
- - Bugfix when calculating height of addin.
99
-
100
- # 1.0.2 (2018-08-13)
101
-
102
- - Added import barrels for interfaces at the root.
103
-
104
- # 1.0.1 (2018-07-26)
105
-
106
- - Added import barrels for interfaces.
107
-
108
- # 1.0.0 (2018-05-01)
109
-
110
- - Added `openHelp` method to client.
111
-
112
- # 1.0.0-alpha.1 (2017-09-11)
113
-
114
- - Account for the add-in's body margin when resizing the iframe height.
115
-
116
- # 1.0.0-alpha.0 (2017-08-25)
117
-
118
- - Initial release.
1
+ # 1.2.1 (2024-04-01)
2
+ - Package updates
3
+
4
+ # 1.2.0 (2023-09-27)
5
+ ### Behavior change
6
+ - Allow host page to determine default values for flyout widths when not provided.
7
+
8
+ # 1.1.5 (2023-02-15)
9
+ - Add `themeChange` callback to indicate when the add-in host page UX theme changes.
10
+
11
+ # 1.1.4 (2023-01-11)
12
+ - Add `actionButtonConfig` and `tabConfig` to AddinClientReadyArgs.
13
+
14
+ # 1.1.3 (2022-05-12)
15
+ - Updated `allowedOrigins` to support Education Management
16
+
17
+ # 1.1.2 (2022-02-01)
18
+ - Updated `allowedOrigins` to support congregant portal
19
+
20
+ # 1.1.1 (2021-06-01)
21
+ - Add support for sending custom events to the add-in host page.
22
+
23
+ # 1.1.0 (2020-11-19)
24
+ - Deprecate help widget related functionality.
25
+
26
+ # 1.0.21 (2020-11-04)
27
+ - Add support for event handler to process blocking events from the add-in host.
28
+
29
+ # 1.0.20 (2020-07-28)
30
+ - Add event handler for processing events sent from the add-in host.
31
+
32
+ # 1.0.19 (2020-07-07)
33
+ - Updated `allowedOrigins` to support Luminate Online
34
+
35
+ # 1.0.18 (2020-06-04)
36
+ - Fixed a bug where localhost required a port in the allowed origins list. [#40](https://github.com/blackbaud/sky-addin-client/pull/40) (Thanks [@MatthewMazaika](https://github.com/MatthewMazaika)!)
37
+
38
+ # 1.0.17 (2020-05-06)
39
+ - Added `updateContext` callback to notify add-in when context information has been updated.
40
+
41
+
42
+ # 1.0.16 (2020-04-22)
43
+ - Added `showWait` and `hideWait` methods to allow developers to show/hide a page-blocking-wait, respectively.
44
+
45
+ # 1.0.15 (2020-04-02)
46
+
47
+ - Updated `devDependencies` and instructions for consuming from CDN.
48
+
49
+ # 1.0.14 (2020-03-04)
50
+
51
+ - Added `AddinModalConfig` with optional `fullPage` property (Default: false) to indicate if a modal add-in will be
52
+ displayed full page.
53
+
54
+ # 1.0.13 (2019-10-04)
55
+
56
+ - Added `removeInset` property to `AddinTileConfig` to specify whether the tile content inset should be removed
57
+ which allows the content to extend all the way to the edge of the tile container (Default: false)
58
+
59
+ # 1.0.12 (2019-05-14)
60
+
61
+ - Added a `showConfirm` method to allow developers to show a confirm dialog with a title, description body,
62
+ and button configuration containing custom actions to return when the dialog closes.
63
+ - Added a `showError` method to allow developers to show an error dialog with a title, error description, and
64
+ text for the close button.
65
+
66
+ # 1.0.11 (2019-05-03)
67
+
68
+ - Added a `closeFlyout` method to allow developers to close a flyout panel.
69
+ - The `showFlyout` method will now return a Promise which will resolve when the flyout is closed.
70
+
71
+ # 1.0.10 (2019-04-16)
72
+
73
+ - Added a `showFlyout` method to allow developers to display supplementary information in a flyout panel.
74
+
75
+ # 1.0.9 (2019-03-01)
76
+
77
+ - Added a `showToast` method to allow developers to show a toast with a provided message and toast style.
78
+
79
+ # 1.0.8 (2019-02-13)
80
+
81
+ - To remove confusion and clarify the intent, we've added a new method named `getUserIdentityToken`. This method is
82
+ used to obtain a user identity token from the host application and replaces the `getAuthToken` method (which is still
83
+ functional but marked as deprecated).
84
+
85
+ - Added tile config options to allow developers to provide additional metadata, such as tile summary details and whether
86
+ to show a tile's help or settings icons.
87
+
88
+ - Added `helpClick` and `settingsClick` callbacks to allow developers to take action when the tile help and settings
89
+ icons (respectfully) are clicked.
90
+
91
+ # 1.0.7 (2019-02-01)
92
+
93
+ - Added a `buttonClick` callback for Button Add-ins to allow developers to take action when buttons are clicked.
94
+
95
+ - Added button config options to support Button Add-ins. This allows developers to provide `style` metadata -
96
+ essentially, the button's intent as it relates to CRUD operations (add, edit, delete). We will add more "styles" as
97
+ requested.
98
+
99
+ # 1.0.3 (2018-09-28)
100
+
101
+ - Bugfix when calculating height of addin.
102
+
103
+ # 1.0.2 (2018-08-13)
104
+
105
+ - Added import barrels for interfaces at the root.
106
+
107
+ # 1.0.1 (2018-07-26)
108
+
109
+ - Added import barrels for interfaces.
110
+
111
+ # 1.0.0 (2018-05-01)
112
+
113
+ - Added `openHelp` method to client.
114
+
115
+ # 1.0.0-alpha.1 (2017-09-11)
116
+
117
+ - Account for the add-in's body margin when resizing the iframe height.
118
+
119
+ # 1.0.0-alpha.0 (2017-08-25)
120
+
121
+ - Initial release.