@justeat/f-braze-adapter
Advanced tools
Comparing version 5.1.1 to 5.2.0
319
CHANGELOG.md
@@ -6,51 +6,61 @@ # Changelog | ||
## v5.2.0 | ||
v5.1.1 | ||
------------------------------ | ||
*February 13, 2022* | ||
_March 13, 2024_ | ||
### Changed | ||
- node engines in `package.json` to include all versions above 14 | ||
## v5.1.1 | ||
_February 13, 2022_ | ||
### Added | ||
- braze sk 3.3.0 under dev dependencies to allow tests to work. | ||
## v5.1.0 | ||
v5.1.0 | ||
------------------------------ | ||
*July 25, 2022* | ||
_July 25, 2022_ | ||
### Added | ||
- Node 16 support. | ||
## v0.5.1 | ||
v0.5.1 | ||
------------------------------ | ||
*June 15, 2022* | ||
_June 15, 2022_ | ||
### Removed | ||
- Removed vite as a dependency and moved to monorepo root `package.json` to solve version conflict issue | ||
v5.0.0 | ||
------------------------------ | ||
*February 23, 2022* | ||
## v5.0.0 | ||
_February 23, 2022_ | ||
### Changed | ||
- **Breaking Change** `logWhileInitialising` function and test in line with new log interface. Make sure to use this.$log instead of this.$logger for this version to work. | ||
### Removed | ||
- local logging service. | ||
## v4.2.0 | ||
v4.2.0 | ||
------------------------------ | ||
*February 08, 2022* | ||
_February 08, 2022_ | ||
### Added | ||
- urlLocationSubstitution filter to replace any URL placeholders | ||
- tests for new filter | ||
## v4.1.0 | ||
v4.1.0 | ||
------------------------------ | ||
*January 18, 2022* | ||
_January 18, 2022_ | ||
### Added | ||
- CurrentLocation to consumer options | ||
@@ -60,40 +70,40 @@ - locationFilter to match users current location if given or exists on card | ||
## v4.0.0 | ||
v4.0.0 | ||
------------------------------ | ||
*November 09, 2021* | ||
_November 09, 2021_ | ||
### Changed | ||
- Updating version to non beta ready for stamp cards | ||
## v4.0.0-beta.6 | ||
v4.0.0-beta.6 | ||
------------------------------ | ||
*September 24, 2021* | ||
_September 24, 2021_ | ||
### Changed | ||
- Updated changeUser method to be the correct implementation based on new brazeSDK | ||
## v4.0.0-beta.5 | ||
v4.0.0-beta.5 | ||
------------------------------ | ||
*September 07, 2021* | ||
_September 07, 2021_ | ||
### Added | ||
- Finer detailed log events for greater error and event visibility | ||
## v4.0.0-beta.4 | ||
v4.0.0-beta.4 | ||
------------------------------ | ||
*September 02, 2021* | ||
_September 02, 2021_ | ||
### Changed | ||
- Changed sdk url to correct version | ||
## v4.0.0-beta.3 | ||
v4.0.0-beta.3 | ||
------------------------------ | ||
*July 20, 2021* | ||
_July 20, 2021_ | ||
### Changed | ||
- Changed how braze adapter is initialised, it is no longer async | ||
@@ -104,26 +114,26 @@ - Increased Braze sdk to the latest version | ||
## v4.0.0-beta.2 | ||
v4.0.0-beta.2 | ||
------------------------------ | ||
*July 19, 2021* | ||
_July 19, 2021_ | ||
### Changed | ||
- Recognises and respects the `is_visible` and `deduplication_key` key-value pairs in the | ||
content-card data | ||
## v3.5.0 | ||
v3.5.0 | ||
------------------------------ | ||
*July 19, 2021* | ||
_July 19, 2021_ | ||
### Changed | ||
- Recognises and respects the `is_visible` and `deduplication_key` key-value pairs in the | ||
content-card data | ||
## v4.0.0-beta.1 | ||
v4.0.0-beta.1 | ||
------------------------------ | ||
*May 19, 2021* | ||
_May 19, 2021_ | ||
### Added | ||
- BrazeConsumer to store the adapters' consumer config | ||
@@ -141,6 +151,8 @@ - BrazeConsumerRegistry to store a list of consumers and apply callbacks for all consumers in list | ||
### Removed | ||
- contentCard service has now been separated into its functions, they are now curried via the pipe function within | ||
the BrazeConsumer when cards are set on the consumer during the callback. | ||
the BrazeConsumer when cards are set on the consumer during the callback. | ||
### Changed | ||
- It now pushes cards and messages out on the DispatcherEventStream via publish method. | ||
@@ -150,128 +162,130 @@ - Modified the BrazeDispatcher to no longer be a singleton. | ||
## v3.4.0 | ||
v3.4.0 | ||
------------------------------ | ||
*April 28, 2021* | ||
_April 28, 2021_ | ||
### Changed | ||
- If the `je-cookieConsent` cookie is unset, or set to something other than `"full"`, the `noCookies` | ||
option will be set on initialisation of the braze SDK. | ||
## v3.3.0 | ||
v3.3.0 | ||
------------------------------ | ||
*March 29, 2021* | ||
_March 29, 2021_ | ||
### Fixed | ||
- Handled a condition where, if appboy was not initialised when `BrazeDispatcher.configure()` was called, | ||
and an in-app message was received, an error would be thrown. | ||
## v3.2.0 | ||
v3.2.0 | ||
------------------------------ | ||
*March 17, 2021* | ||
_March 17, 2021_ | ||
### Changed | ||
- If present, `location` reflected through to card data | ||
## v3.1.0 | ||
v3.1.0 | ||
------------------------------ | ||
*March 17, 2021* | ||
_March 17, 2021_ | ||
### Changed | ||
- If present, `isReadyToClaim` now transformed to a `Boolean` | ||
- If present, `displayTimesJson` now takes effect independent of `brand` being present. | ||
## v3.0.0 | ||
v3.0.0 | ||
------------------------------ | ||
*February 22, 2021* | ||
_February 22, 2021_ | ||
### Added | ||
- Properties for stamp-cards card | ||
### Changed | ||
- Renamed package f-braze-adapter from f-metadata | ||
*December 4, 2020* | ||
_December 4, 2020_ | ||
### Fixed | ||
- Removed optional chaining to fix storybook | ||
## v3.0.0-beta.7 | ||
v3.0.0-beta.7 | ||
------------------------------ | ||
*December 2, 2020* | ||
_December 2, 2020_ | ||
### Added | ||
- Added a logging callbacks to the dispatcher. If provided it returns relevant logging data for each callback. | ||
- Added a logging function and class to support the above callbacks | ||
## v3.0.0-beta.6 | ||
v3.0.0-beta.6 | ||
------------------------------ | ||
*November 30, 2020* | ||
_November 30, 2020_ | ||
### Fixed | ||
- Where cards do not have an order, they are assigned one of `9e9` for ordering, preventing | ||
erroneous ordering. | ||
## v3.0.0-beta.5 | ||
v3.0.0-beta.5 | ||
------------------------------ | ||
*November 23, 2020* | ||
_November 23, 2020_ | ||
### Fixed | ||
- isCardCurrentlyActive now respects displayTimes JSON as specified | ||
- transformCardData now preserves brand_name as provided by braze | ||
## v3.0.0-beta.4 | ||
v3.0.0-beta.4 | ||
------------------------------ | ||
*October 22, 2020* | ||
_October 22, 2020_ | ||
### Changed | ||
- In arrangeCardsByTitles we now push all card data into group rather than just the title, this is to aid in impressions | ||
tracking and future headers that require more than the title being displayed. | ||
tracking and future headers that require more than the title being displayed. | ||
## v3.0.0-beta.3 | ||
v3.0.0-beta.3 | ||
------------------------------ | ||
*October 22, 2020* | ||
_October 22, 2020_ | ||
### Changed | ||
- Adds grouping functionality to Braze dispatcher via new callback | ||
## v3.0.0-beta.2 | ||
v3.0.0-beta.2 | ||
------------------------------ | ||
*October 14, 2020* | ||
_October 14, 2020_ | ||
### Changed | ||
- Integrates home promo card 1 & 2 changes from released f-content-card | ||
## v3.0.0-beta.1 | ||
v3.0.0-beta.1 | ||
------------------------------ | ||
*September 15, 2020* | ||
_September 15, 2020_ | ||
### Changed | ||
- Vue CLI minor package updates. | ||
- Begins the decoupling of f-metadata from f-content-cards, allowing callbacks for multiple components to be registered | ||
## v2.8.1 | ||
v2.8.1 | ||
------------------------------ | ||
*June 29, 2020* | ||
_June 29, 2020_ | ||
### Fixed | ||
- Only subscribe to button click event when the button exists. | ||
## v2.8.0 | ||
v2.8.0 | ||
------------------------------ | ||
*June 26, 2020* | ||
_June 26, 2020_ | ||
### Added | ||
- Methods for logging card click and view events, with the view to presenting a consistent | ||
@@ -282,155 +296,159 @@ interface for sending information back to braze: | ||
## v2.7.0 | ||
v2.7.0 | ||
------------------------------ | ||
*June 24, 2020* | ||
_June 24, 2020_ | ||
### Changed | ||
- Promises to async/await | ||
## v2.6.0 | ||
v2.6.0 | ||
------------------------------ | ||
*June 16, 2020* | ||
_June 16, 2020_ | ||
### Added | ||
- Check for previously initialised Braze instances on window and skip import of the SDK | ||
### Changed | ||
- ESLint autofix turned off (so that tests don't pass due to `--fix` being applied, but then publish subsequently fails) | ||
## v2.5.0 | ||
v2.5.0 | ||
------------------------------ | ||
*May 27, 2020* | ||
_May 27, 2020_ | ||
### Changed | ||
- Add `interceptInAppMessageClickEvents` callback method | ||
## v2.4.0 | ||
v2.4.0 | ||
------------------------------ | ||
*May 13, 2020* | ||
_May 13, 2020_ | ||
### Changed | ||
- Manually coerce in-app messages to allow apps to intercept and extend functionality. | ||
## v2.3.4 | ||
v2.3.4 | ||
------------------------------ | ||
*May 12, 2020* | ||
_May 12, 2020_ | ||
### Changed | ||
- Updating `@vue/cli-plugin-unit-test` to v4.3.1. | ||
- Ordering of callbacks to ensure they're initialised before used | ||
## v2.3.3 | ||
v2.3.3 | ||
------------------------------ | ||
*May 6, 2020* | ||
_May 6, 2020_ | ||
### Changed | ||
- `appboy-web-sdk` version from `2.4.1` to `2.5.2` | ||
## v2.3.2 | ||
v2.3.2 | ||
------------------------------ | ||
*May 4, 2020* | ||
_May 4, 2020_ | ||
### Fixed | ||
- Cache issue with Braze by setting `sessionTimeoutInSeconds` to `0`. | ||
## v2.3.1 | ||
v2.3.1 | ||
------------------------------ | ||
*April 3, 2020* | ||
_April 3, 2020_ | ||
### Fixed | ||
- Failing test (locally) due to dynamic imports not being supported when running `jest` without the `dynamic-import-node` plugin. | ||
- Small linting fix and abstracted out code coverage to separate `test:coverage` script in package.json. | ||
## v2.3.0 | ||
v2.3.0 | ||
------------------------------ | ||
*March 2, 2020* | ||
_March 2, 2020_ | ||
### Changed | ||
- Callback with `null` if `apiKey` or `userId` is not defined. | ||
- Return before SDK import if dependencies are not available. | ||
## v2.2.0 | ||
v2.2.0 | ||
------------------------------ | ||
*February 20, 2020* | ||
_February 20, 2020_ | ||
### Added | ||
- Jest configuration and unit tests for both server and client. | ||
### Changed | ||
- Promisify `f-metadata` initialisation and improve error handling. | ||
- Callback resolve with the appboy instance. | ||
## v2.1.0 | ||
v2.1.0 | ||
------------------------------ | ||
*February 18, 2020* | ||
_February 18, 2020_ | ||
### Changed | ||
- Call `handleContentCards` with an empty array if no content cards are available, enabling any side effects once Braze is called. | ||
## v2.0.0 | ||
v2.0.0 | ||
------------------------------ | ||
*February 10, 2020* | ||
_February 10, 2020_ | ||
### Changed | ||
- Callback methods are now called with the whole appboy instance ensuring functionality is available on the appboy instance whenever a refresh is called. This also means that the callback will always return an object even when no content cards are available. Further instructions and upgrade instructions can be found in the [README](README.md). | ||
## v1.0.4 | ||
v1.0.4 | ||
------------------------------ | ||
*February 10, 2020* | ||
_February 10, 2020_ | ||
### Fixed | ||
- Ensure that `handleContentCards` callback has been set before attempting to call it. | ||
## v1.0.3 | ||
v1.0.3 | ||
------------------------------ | ||
*January 29, 2020* | ||
_January 29, 2020_ | ||
### Added | ||
- `requestContentCardsRefresh()` call back as on some page refreshes it fails to invoke sync. | ||
## v1.0.2 | ||
v1.0.2 | ||
------------------------------ | ||
*January 29, 2020* | ||
_January 29, 2020_ | ||
### Changed | ||
- Bumped `appboy-web-sdk` because of a known `contentCard` issue in 2.4.0 | ||
### Removed | ||
- `requestContentCardsRefresh()` unnecessary call. | ||
### Fixed | ||
- `ContentCard` - Not displaying on initial first load due to appboy `sync` | ||
calls happening before the sdk is ready to update the | ||
`ab.storage.cc.[api-key]` in localStorage. Now using `subscribeToContentCardsUpdates` to listen | ||
for updates. | ||
calls happening before the sdk is ready to update the | ||
`ab.storage.cc.[api-key]` in localStorage. Now using `subscribeToContentCardsUpdates` to listen | ||
for updates. | ||
## v1.0.1 | ||
v1.0.1 | ||
------------------------------ | ||
*November 18, 2019* | ||
_November 18, 2019_ | ||
### Fixed | ||
- GTM event loading issues | ||
## v1.0.0 | ||
v1.0.0 | ||
------------------------------ | ||
*November 15, 2019* | ||
_November 15, 2019_ | ||
### Added | ||
- Support for handling content cards through SDK methods | ||
@@ -441,28 +459,29 @@ - User ID to `initialiseBraze` function | ||
### Changed | ||
- Changing Braze to be a dynamic import | ||
- Don't bundle `f-metadata`, leave that to the consuming component. | ||
## v0.3.0 | ||
v0.3.0 | ||
------------------------------ | ||
*October 4, 2019* | ||
_October 4, 2019_ | ||
### Added | ||
- Babel config (as wasn't transpiling ES functionality) | ||
## v0.2.0 | ||
v0.2.0 | ||
------------------------------ | ||
*October 2, 2019* | ||
_October 2, 2019_ | ||
### Added | ||
- `disable` toggle added to disable Braze | ||
## v0.1.0 | ||
v0.1.0 | ||
------------------------------ | ||
*September 19, 2019* | ||
_September 19, 2019_ | ||
### Added | ||
- Created package | ||
- Enabling initialisation of Braze |
{ | ||
"name": "@justeat/f-braze-adapter", | ||
"description": "Fozzie Metadata Service", | ||
"version": "5.1.1", | ||
"version": "5.2.0", | ||
"main": "dist/f-braze-adapter.umd.js", | ||
@@ -26,3 +26,3 @@ "module": "dist/f-braze-adapter.es.js", | ||
"engines": { | ||
"node": "^12 || ^14 || ^16" | ||
"node": ">=14" | ||
}, | ||
@@ -59,3 +59,6 @@ "keywords": [ | ||
}, | ||
"gitHead": "e7215edb1a5f3e13724cddd1648d5887f8951e3c" | ||
"volta": { | ||
"extends": "../../../package.json" | ||
}, | ||
"gitHead": "c905adfcc68907f9f325428895be347acd1bffcb" | ||
} |
300704