Basic Usage

1. install using npm i @penguinwolf/braze-integration
2. import into your project and construct the integration

import BrazeIntegration from "@penguin-wolf/braze-integration";

const sdkKey = '...';
const sdkUrl = '...';
const enableLogging = scriptData.WP_ENV === 'development'; // note: only enable logging on development environments

const brazeIntegration = new BrazeIntegration(sdkKey, sdkUrl, enableLogging);

3. You can access the Braze SDK instance directly from the brazeIntegration object

const braze = brazeIntegration.braze;
braze.logCustomEvent('set_location', {
  location: 'QLD',
});

Updating the Braze SDK

1. Clone this repo
2. Run npm i @braze/web-sdk@latest to update the Braze SDK to the latest
3. Increment the package version in package.json, run npm i to update package-lock.json
4. Commit and then tag with the new version like so git tag -a v2.0.1, changing the version to match package.json
5. Push changes and tags: git push && git push --tags
6. Publish to npm with npm publish (note: you will need to be authenticated with the @penguin-wolf npm account)
7. In a project that uses this module use npm outdated to check for updates and @penguin-wolf/braze-integration to install the latest version of this module. Rebuild and deploy as normal

TODO

• [ ] Make warning for "multiple braze versions loaded" explicitly say which version is already loaded and which version we are trying to load now