@braze/web-sdk 3.4.1 → 4.0.0

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 (169) hide show
  1. package/README.md +5 -11
  2. package/index.d.ts +490 -513
  3. package/package.json +8 -7
  4. package/shared-lib/braze-shared-lib.js +1 -0
  5. package/shared-lib/encoding-utils.js +1 -0
  6. package/shared-lib/event-types.js +1 -0
  7. package/shared-lib/guid.js +1 -0
  8. package/shared-lib/indexed-db-adapter.js +1 -0
  9. package/shared-lib/logger.js +1 -0
  10. package/shared-lib/supported-options.js +1 -0
  11. package/src/Card/card-manager-factory.js +1 -0
  12. package/src/Card/card-manager.js +1 -0
  13. package/src/Card/display/card-display.js +1 -0
  14. package/src/Card/index.js +1 -0
  15. package/src/Card/log-card-click.js +1 -0
  16. package/src/Card/log-card-dismissal.js +1 -0
  17. package/src/Card/log-card-impressions.js +1 -0
  18. package/src/Card/models/banner.js +1 -0
  19. package/src/Card/models/captioned-image.js +1 -0
  20. package/src/Card/models/card.js +1 -0
  21. package/src/Card/models/classic-card.js +1 -0
  22. package/src/Card/models/control-card.js +1 -0
  23. package/src/Card/models/index.js +1 -0
  24. package/src/Card/util/card-factory.js +1 -0
  25. package/src/ContentCards/content-cards-provider-factory.js +1 -0
  26. package/src/ContentCards/content-cards-provider.js +1 -0
  27. package/src/ContentCards/content-cards.js +1 -0
  28. package/src/ContentCards/get-cached-content-cards.js +1 -0
  29. package/src/ContentCards/index.js +1 -0
  30. package/src/ContentCards/log-content-cards-displayed.js +1 -0
  31. package/src/ContentCards/request-content-cards-refresh.js +1 -0
  32. package/src/ContentCards/subscribe-to-content-cards-updates.js +1 -0
  33. package/src/ContentCards/ui/hide-content-cards.js +1 -0
  34. package/src/ContentCards/ui/show-content-cards.js +1 -0
  35. package/src/ContentCards/ui/toggle-content-cards.js +1 -0
  36. package/src/Core/add-sdk-metadata.js +1 -0
  37. package/src/Core/braze-sdk-metadata.js +1 -0
  38. package/src/Core/change-user.js +1 -0
  39. package/src/Core/destroy.js +1 -0
  40. package/src/Core/device-properties.js +1 -0
  41. package/src/Core/disable-sdk.js +1 -0
  42. package/src/Core/enable-sdk.js +1 -0
  43. package/src/Core/get-device-id.js +1 -0
  44. package/src/Core/get-user.js +1 -0
  45. package/src/Core/handle-braze-action.js +1 -0
  46. package/src/Core/index.js +1 -0
  47. package/src/Core/initialize.js +1 -0
  48. package/src/Core/is-disabled.js +1 -0
  49. package/src/Core/log-custom-event.js +1 -0
  50. package/src/Core/log-purchase.js +1 -0
  51. package/src/Core/open-session.js +1 -0
  52. package/src/Core/remove-all-subscriptions.js +1 -0
  53. package/src/Core/remove-subscription.js +1 -0
  54. package/src/Core/request-immediate-data-flush.js +1 -0
  55. package/src/Core/set-logger.js +1 -0
  56. package/src/Core/set-sdk-authentication-signature.js +1 -0
  57. package/src/Core/subscribe-to-sdk-authentication-failures.js +1 -0
  58. package/src/Core/toggle-logging.js +1 -0
  59. package/src/Core/wipe-data.js +1 -0
  60. package/src/Feed/feed-provider-factory.js +1 -0
  61. package/src/Feed/feed-provider.js +1 -0
  62. package/src/Feed/feed.js +1 -0
  63. package/src/Feed/get-cached-feed.js +1 -0
  64. package/src/Feed/index.js +1 -0
  65. package/src/Feed/log-feed-displayed.js +1 -0
  66. package/src/Feed/request-feed-refresh.js +1 -0
  67. package/src/Feed/subscribe-to-feed-updates.js +1 -0
  68. package/src/Feed/ui/hide-feed.js +1 -0
  69. package/src/Feed/ui/show-feed.js +1 -0
  70. package/src/Feed/ui/toggle-feed.js +1 -0
  71. package/src/InAppMessage/display/get-animation-effect.js +1 -0
  72. package/src/InAppMessage/display/html-message-to-html.js +1 -0
  73. package/src/InAppMessage/display/in-app-message-to-html.js +1 -0
  74. package/src/InAppMessage/display/modal-utils.js +1 -0
  75. package/src/InAppMessage/in-app-message-factory.js +1 -0
  76. package/src/InAppMessage/in-app-message-manager-factory.js +1 -0
  77. package/src/InAppMessage/in-app-message-manager.js +1 -0
  78. package/src/InAppMessage/index.js +1 -0
  79. package/src/InAppMessage/log-in-app-message-button-click.js +1 -0
  80. package/src/InAppMessage/log-in-app-message-click.js +1 -0
  81. package/src/InAppMessage/log-in-app-message-html-click.js +1 -0
  82. package/src/InAppMessage/log-in-app-message-impression.js +1 -0
  83. package/src/InAppMessage/models/control-message.js +1 -0
  84. package/src/InAppMessage/models/full-screen-message.js +1 -0
  85. package/src/InAppMessage/models/html-message.js +1 -0
  86. package/src/InAppMessage/models/in-app-message-button.js +1 -0
  87. package/src/InAppMessage/models/in-app-message.js +1 -0
  88. package/src/InAppMessage/models/modal-message.js +1 -0
  89. package/src/InAppMessage/models/slide-up-message.js +1 -0
  90. package/src/InAppMessage/models/templated-in-app-message.js +1 -0
  91. package/src/InAppMessage/subscribe-to-in-app-message.js +1 -0
  92. package/src/InAppMessage/ui/automatically-show-in-app-messages.js +1 -0
  93. package/src/InAppMessage/ui/show-in-app-message.js +1 -0
  94. package/src/Push/index.js +1 -0
  95. package/src/Push/is-push-blocked.js +1 -0
  96. package/src/Push/is-push-permission-granted.js +1 -0
  97. package/src/Push/is-push-supported.js +1 -0
  98. package/src/Push/push-manager-factory.js +1 -0
  99. package/src/Push/push-manager.js +1 -0
  100. package/src/Push/request-push-permission.js +1 -0
  101. package/src/Push/unregister-push.js +1 -0
  102. package/src/User/index.js +1 -0
  103. package/src/User/user-manager.js +1 -0
  104. package/src/User/user.js +1 -0
  105. package/src/common/base-feed.js +1 -0
  106. package/src/common/base-provider.js +1 -0
  107. package/src/common/constants.js +1 -0
  108. package/src/common/event-logger.js +1 -0
  109. package/src/common/feed-display.js +1 -0
  110. package/src/common/translations.js +1 -0
  111. package/src/index.js +1 -0
  112. package/src/l10n/l10n-manager-factory.js +1 -0
  113. package/src/l10n/l10n-manager.js +1 -0
  114. package/src/managers/auth-manager.js +1 -0
  115. package/src/managers/braze-instance.js +1 -0
  116. package/src/managers/device-manager.js +1 -0
  117. package/src/managers/network-manager.js +1 -0
  118. package/src/managers/server-config-manager.js +1 -0
  119. package/src/managers/session-manager.js +1 -0
  120. package/src/managers/storage-manager-factory.js +1 -0
  121. package/src/managers/storage-manager.js +1 -0
  122. package/src/managers/subscription-manager.js +1 -0
  123. package/src/models/backend-errors.js +1 -0
  124. package/src/models/braze-event.js +1 -0
  125. package/src/models/braze-sdk-metadata.js +1 -0
  126. package/src/models/device.js +1 -0
  127. package/src/models/identifier.js +1 -0
  128. package/src/models/push-token.js +1 -0
  129. package/src/models/request-result.js +1 -0
  130. package/src/models/server-config.js +1 -0
  131. package/src/request-controller.js +1 -0
  132. package/src/triggers/models/custom-event-data.js +1 -0
  133. package/src/triggers/models/custom-event-property-data.js +1 -0
  134. package/src/triggers/models/filter-set.js +1 -0
  135. package/src/triggers/models/filter.js +1 -0
  136. package/src/triggers/models/in-app-message-click-data.js +1 -0
  137. package/src/triggers/models/purchase-data.js +1 -0
  138. package/src/triggers/models/purchase-property-data.js +1 -0
  139. package/src/triggers/models/push-click-data.js +1 -0
  140. package/src/triggers/models/trigger-condition.js +1 -0
  141. package/src/triggers/models/trigger-events.js +1 -0
  142. package/src/triggers/models/trigger.js +1 -0
  143. package/src/triggers/triggers-provider-factory.js +1 -0
  144. package/src/triggers/triggers-provider.js +1 -0
  145. package/src/ui/js/attach-css.js +1 -0
  146. package/src/ui/js/feed-css.js +1 -0
  147. package/src/ui/js/iam-css.js +1 -0
  148. package/src/ui/js/index.js +1 -0
  149. package/src/ui/js/load-font-awesome.js +1 -0
  150. package/src/util/base-device-parser.js +1 -0
  151. package/src/util/braze-actions.js +1 -0
  152. package/src/util/browser-detector.js +1 -0
  153. package/src/util/client-hints-parser.js +1 -0
  154. package/src/util/code-utils.js +1 -0
  155. package/src/util/color-utils.js +1 -0
  156. package/src/util/component-utils.js +1 -0
  157. package/src/util/date-utils.js +1 -0
  158. package/src/util/deprecation-utils.js +1 -0
  159. package/src/util/device-constants.js +1 -0
  160. package/src/util/dom-utils.js +1 -0
  161. package/src/util/key-codes.js +1 -0
  162. package/src/util/math.js +1 -0
  163. package/src/util/net.js +1 -0
  164. package/src/util/string-utils.js +1 -0
  165. package/src/util/url-utils.js +1 -0
  166. package/src/util/user-agent-parser.js +1 -0
  167. package/src/util/validation-utils.js +1 -0
  168. package/src/util/window-utils.js +1 -0
  169. package/appboy.min.js +0 -275
package/README.md CHANGED
@@ -1,18 +1,12 @@
1
- # Install
1
+ # Braze Web SDK
2
2
 
3
3
  ```shell
4
4
  $ npm install --save @braze/web-sdk
5
5
  ```
6
6
 
7
- This will install the Braze Web SDK files into `./node_modules/@braze/web-sdk` where you can reference them locally. Note that the Braze Web SDK is meant to be used client-side in a web application and may not work as expected in a Node.js server environment.
7
+ Note: The Braze Web SDK is meant to be used client-side in a web application and may not work as expected in a Node.js server environment.
8
8
 
9
- # Usage
9
+ See the [Public Github Repo](https://github.com/braze-inc/braze-web-sdk#readme) for getting started instructions or [our documentation pages](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/) for use-case based documentation.
10
10
 
11
- ```javascript
12
- var appboy = require('@braze/web-sdk');
13
- appboy.initialize('YOUR-API-KEY', { baseUrl: 'YOUR-SDK-ENDPOINT' });
14
- appboy.display.automaticallyShowNewInAppMessages();
15
- appboy.openSession();
16
- ```
17
-
18
- See the [Public Github Repo](https://github.com/Appboy/appboy-web-sdk#readme) for getting started instructions or [our documentation pages](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/) for use-case based documentation.
11
+ (c) Braze, Inc. 2022 - http://braze.com
12
+ License available at https://github.com/braze-inc/braze-web-sdk/blob/master/LICENSE